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;
Chris@13: 
Chris@13: use Psy\VersionUpdater\GitHubChecker;
Chris@13: use Symfony\Component\Console\Input\ArgvInput;
Chris@13: use Symfony\Component\Console\Input\InputArgument;
Chris@13: use Symfony\Component\Console\Input\InputDefinition;
Chris@13: use Symfony\Component\Console\Input\InputOption;
Chris@13: use XdgBaseDir\Xdg;
Chris@13: 
Chris@17: if (!\function_exists('Psy\sh')) {
Chris@13:     /**
Chris@13:      * Command to return the eval-able code to startup PsySH.
Chris@13:      *
Chris@13:      *     eval(\Psy\sh());
Chris@13:      *
Chris@13:      * @return string
Chris@13:      */
Chris@13:     function sh()
Chris@13:     {
Chris@16:         return 'extract(\Psy\debug(get_defined_vars(), isset($this) ? $this : @get_called_class()));';
Chris@13:     }
Chris@13: }
Chris@13: 
Chris@17: if (!\function_exists('Psy\debug')) {
Chris@13:     /**
Chris@13:      * Invoke a Psy Shell from the current context.
Chris@13:      *
Chris@13:      * For example:
Chris@13:      *
Chris@13:      *     foreach ($items as $item) {
Chris@13:      *         \Psy\debug(get_defined_vars());
Chris@13:      *     }
Chris@13:      *
Chris@13:      * If you would like your shell interaction to affect the state of the
Chris@13:      * current context, you can extract() the values returned from this call:
Chris@13:      *
Chris@13:      *     foreach ($items as $item) {
Chris@13:      *         extract(\Psy\debug(get_defined_vars()));
Chris@13:      *         var_dump($item); // will be whatever you set $item to in Psy Shell
Chris@13:      *     }
Chris@13:      *
Chris@16:      * Optionally, supply an object as the `$bindTo` parameter. This determines
Chris@16:      * the value `$this` will have in the shell, and sets up class scope so that
Chris@16:      * private and protected members are accessible:
Chris@13:      *
Chris@13:      *     class Foo {
Chris@13:      *         function bar() {
Chris@13:      *             \Psy\debug(get_defined_vars(), $this);
Chris@13:      *         }
Chris@13:      *     }
Chris@13:      *
Chris@16:      * For the static equivalent, pass a class name as the `$bindTo` parameter.
Chris@16:      * This makes `self` work in the shell, and sets up static scope so that
Chris@16:      * private and protected static members are accessible:
Chris@16:      *
Chris@16:      *     class Foo {
Chris@16:      *         static function bar() {
Chris@16:      *             \Psy\debug(get_defined_vars(), get_called_class());
Chris@16:      *         }
Chris@16:      *     }
Chris@16:      *
Chris@16:      * @param array         $vars   Scope variables from the calling context (default: array())
Chris@16:      * @param object|string $bindTo Bound object ($this) or class (self) value for the shell
Chris@13:      *
Chris@13:      * @return array Scope variables from the debugger session
Chris@13:      */
Chris@16:     function debug(array $vars = [], $bindTo = null)
Chris@13:     {
Chris@13:         echo PHP_EOL;
Chris@13: 
Chris@13:         $sh = new Shell();
Chris@13:         $sh->setScopeVariables($vars);
Chris@13: 
Chris@13:         // Show a couple of lines of call context for the debug session.
Chris@13:         //
Chris@13:         // @todo come up with a better way of doing this which doesn't involve injecting input :-P
Chris@13:         if ($sh->has('whereami')) {
Chris@13:             $sh->addInput('whereami -n2', true);
Chris@13:         }
Chris@13: 
Chris@17:         if (\is_string($bindTo)) {
Chris@16:             $sh->setBoundClass($bindTo);
Chris@16:         } elseif ($bindTo !== null) {
Chris@16:             $sh->setBoundObject($bindTo);
Chris@13:         }
Chris@13: 
Chris@13:         $sh->run();
Chris@13: 
Chris@13:         return $sh->getScopeVariables(false);
Chris@13:     }
Chris@13: }
Chris@13: 
Chris@17: if (!\function_exists('Psy\info')) {
Chris@13:     /**
Chris@13:      * Get a bunch of debugging info about the current PsySH environment and
Chris@13:      * configuration.
Chris@13:      *
Chris@13:      * If a Configuration param is passed, that configuration is stored and
Chris@13:      * used for the current shell session, and no debugging info is returned.
Chris@13:      *
Chris@13:      * @param Configuration|null $config
Chris@13:      *
Chris@13:      * @return array|null
Chris@13:      */
Chris@13:     function info(Configuration $config = null)
Chris@13:     {
Chris@13:         static $lastConfig;
Chris@13:         if ($config !== null) {
Chris@13:             $lastConfig = $config;
Chris@13: 
Chris@13:             return;
Chris@13:         }
Chris@13: 
Chris@13:         $xdg = new Xdg();
Chris@17:         $home = \rtrim(\str_replace('\\', '/', $xdg->getHomeDir()), '/');
Chris@17:         $homePattern = '#^' . \preg_quote($home, '#') . '/#';
Chris@13: 
Chris@13:         $prettyPath = function ($path) use ($homePattern) {
Chris@17:             if (\is_string($path)) {
Chris@17:                 return \preg_replace($homePattern, '~/', $path);
Chris@13:             } else {
Chris@13:                 return $path;
Chris@13:             }
Chris@13:         };
Chris@13: 
Chris@13:         $config = $lastConfig ?: new Configuration();
Chris@13: 
Chris@13:         $core = [
Chris@13:             'PsySH version'       => Shell::VERSION,
Chris@13:             'PHP version'         => PHP_VERSION,
Chris@13:             'OS'                  => PHP_OS,
Chris@13:             'default includes'    => $config->getDefaultIncludes(),
Chris@13:             'require semicolons'  => $config->requireSemicolons(),
Chris@13:             'error logging level' => $config->errorLoggingLevel(),
Chris@13:             'config file'         => [
Chris@13:                 'default config file' => $prettyPath($config->getConfigFile()),
Chris@13:                 'local config file'   => $prettyPath($config->getLocalConfigFile()),
Chris@17:                 'PSYSH_CONFIG env'    => $prettyPath(\getenv('PSYSH_CONFIG')),
Chris@13:             ],
Chris@13:             // 'config dir'  => $config->getConfigDir(),
Chris@13:             // 'data dir'    => $config->getDataDir(),
Chris@13:             // 'runtime dir' => $config->getRuntimeDir(),
Chris@13:         ];
Chris@13: 
Chris@13:         // Use an explicit, fresh update check here, rather than relying on whatever is in $config.
Chris@13:         $checker = new GitHubChecker();
Chris@13:         $updateAvailable = null;
Chris@13:         $latest = null;
Chris@13:         try {
Chris@13:             $updateAvailable = !$checker->isLatest();
Chris@13:             $latest = $checker->getLatest();
Chris@13:         } catch (\Exception $e) {
Chris@13:         }
Chris@13: 
Chris@13:         $updates = [
Chris@13:             'update available'       => $updateAvailable,
Chris@13:             'latest release version' => $latest,
Chris@13:             'update check interval'  => $config->getUpdateCheck(),
Chris@13:             'update cache file'      => $prettyPath($config->getUpdateCheckCacheFile()),
Chris@13:         ];
Chris@13: 
Chris@13:         if ($config->hasReadline()) {
Chris@17:             $info = \readline_info();
Chris@13: 
Chris@13:             $readline = [
Chris@13:                 'readline available' => true,
Chris@13:                 'readline enabled'   => $config->useReadline(),
Chris@17:                 'readline service'   => \get_class($config->getReadline()),
Chris@13:             ];
Chris@13: 
Chris@13:             if (isset($info['library_version'])) {
Chris@13:                 $readline['readline library'] = $info['library_version'];
Chris@13:             }
Chris@13: 
Chris@13:             if (isset($info['readline_name']) && $info['readline_name'] !== '') {
Chris@13:                 $readline['readline name'] = $info['readline_name'];
Chris@13:             }
Chris@13:         } else {
Chris@13:             $readline = [
Chris@13:                 'readline available' => false,
Chris@13:             ];
Chris@13:         }
Chris@13: 
Chris@13:         $pcntl = [
Chris@17:             'pcntl available' => \function_exists('pcntl_signal'),
Chris@17:             'posix available' => \function_exists('posix_getpid'),
Chris@13:         ];
Chris@13: 
Chris@17:         $disabledFuncs = \array_map('trim', \explode(',', \ini_get('disable_functions')));
Chris@17:         if (\in_array('pcntl_signal', $disabledFuncs) || \in_array('pcntl_fork', $disabledFuncs)) {
Chris@13:             $pcntl['pcntl disabled'] = true;
Chris@13:         }
Chris@13: 
Chris@13:         $history = [
Chris@13:             'history file'     => $prettyPath($config->getHistoryFile()),
Chris@13:             'history size'     => $config->getHistorySize(),
Chris@13:             'erase duplicates' => $config->getEraseDuplicates(),
Chris@13:         ];
Chris@13: 
Chris@13:         $docs = [
Chris@13:             'manual db file'   => $prettyPath($config->getManualDbFile()),
Chris@13:             'sqlite available' => true,
Chris@13:         ];
Chris@13: 
Chris@13:         try {
Chris@13:             if ($db = $config->getManualDb()) {
Chris@13:                 if ($q = $db->query('SELECT * FROM meta;')) {
Chris@13:                     $q->setFetchMode(\PDO::FETCH_KEY_PAIR);
Chris@13:                     $meta = $q->fetchAll();
Chris@13: 
Chris@13:                     foreach ($meta as $key => $val) {
Chris@13:                         switch ($key) {
Chris@13:                             case 'built_at':
Chris@13:                                 $d = new \DateTime('@' . $val);
Chris@13:                                 $val = $d->format(\DateTime::RFC2822);
Chris@13:                                 break;
Chris@13:                         }
Chris@17:                         $key = 'db ' . \str_replace('_', ' ', $key);
Chris@13:                         $docs[$key] = $val;
Chris@13:                     }
Chris@13:                 } else {
Chris@13:                     $docs['db schema'] = '0.1.0';
Chris@13:                 }
Chris@13:             }
Chris@13:         } catch (Exception\RuntimeException $e) {
Chris@13:             if ($e->getMessage() === 'SQLite PDO driver not found') {
Chris@13:                 $docs['sqlite available'] = false;
Chris@13:             } else {
Chris@13:                 throw $e;
Chris@13:             }
Chris@13:         }
Chris@13: 
Chris@13:         $autocomplete = [
Chris@13:             'tab completion enabled' => $config->useTabCompletion(),
Chris@17:             'custom matchers'        => \array_map('get_class', $config->getTabCompletionMatchers()),
Chris@13:             'bracketed paste'        => $config->useBracketedPaste(),
Chris@13:         ];
Chris@13: 
Chris@13:         // Shenanigans, but totally justified.
Chris@13:         if ($shell = Sudo::fetchProperty($config, 'shell')) {
Chris@17:             $core['loop listeners'] = \array_map('get_class', Sudo::fetchProperty($shell, 'loopListeners'));
Chris@17:             $core['commands']       = \array_map('get_class', $shell->all());
Chris@13: 
Chris@17:             $autocomplete['custom matchers'] = \array_map('get_class', Sudo::fetchProperty($shell, 'matchers'));
Chris@13:         }
Chris@13: 
Chris@13:         // @todo Show Presenter / custom casters.
Chris@13: 
Chris@17:         return \array_merge($core, \compact('updates', 'pcntl', 'readline', 'history', 'docs', 'autocomplete'));
Chris@13:     }
Chris@13: }
Chris@13: 
Chris@17: if (!\function_exists('Psy\bin')) {
Chris@13:     /**
Chris@13:      * `psysh` command line executable.
Chris@13:      *
Chris@13:      * @return \Closure
Chris@13:      */
Chris@13:     function bin()
Chris@13:     {
Chris@13:         return function () {
Chris@13:             $usageException = null;
Chris@13: 
Chris@13:             $input = new ArgvInput();
Chris@13:             try {
Chris@13:                 $input->bind(new InputDefinition([
Chris@13:                     new InputOption('help',     'h',  InputOption::VALUE_NONE),
Chris@13:                     new InputOption('config',   'c',  InputOption::VALUE_REQUIRED),
Chris@13:                     new InputOption('version',  'v',  InputOption::VALUE_NONE),
Chris@13:                     new InputOption('cwd',      null, InputOption::VALUE_REQUIRED),
Chris@13:                     new InputOption('color',    null, InputOption::VALUE_NONE),
Chris@13:                     new InputOption('no-color', null, InputOption::VALUE_NONE),
Chris@13: 
Chris@13:                     new InputArgument('include', InputArgument::IS_ARRAY),
Chris@13:                 ]));
Chris@13:             } catch (\RuntimeException $e) {
Chris@13:                 $usageException = $e;
Chris@13:             }
Chris@13: 
Chris@13:             $config = [];
Chris@13: 
Chris@13:             // Handle --config
Chris@13:             if ($configFile = $input->getOption('config')) {
Chris@13:                 $config['configFile'] = $configFile;
Chris@13:             }
Chris@13: 
Chris@13:             // Handle --color and --no-color
Chris@13:             if ($input->getOption('color') && $input->getOption('no-color')) {
Chris@13:                 $usageException = new \RuntimeException('Using both "--color" and "--no-color" options is invalid');
Chris@13:             } elseif ($input->getOption('color')) {
Chris@13:                 $config['colorMode'] = Configuration::COLOR_MODE_FORCED;
Chris@13:             } elseif ($input->getOption('no-color')) {
Chris@13:                 $config['colorMode'] = Configuration::COLOR_MODE_DISABLED;
Chris@13:             }
Chris@13: 
Chris@13:             $shell = new Shell(new Configuration($config));
Chris@13: 
Chris@13:             // Handle --help
Chris@13:             if ($usageException !== null || $input->getOption('help')) {
Chris@13:                 if ($usageException !== null) {
Chris@13:                     echo $usageException->getMessage() . PHP_EOL . PHP_EOL;
Chris@13:                 }
Chris@13: 
Chris@13:                 $version = $shell->getVersion();
Chris@17:                 $name    = \basename(\reset($_SERVER['argv']));
Chris@13:                 echo <<<EOL
Chris@13: $version
Chris@13: 
Chris@13: Usage:
Chris@13:   $name [--version] [--help] [files...]
Chris@13: 
Chris@13: Options:
Chris@13:   --help     -h Display this help message.
Chris@13:   --config   -c Use an alternate PsySH config file location.
Chris@13:   --cwd         Use an alternate working directory.
Chris@13:   --version  -v Display the PsySH version.
Chris@13:   --color       Force colors in output.
Chris@13:   --no-color    Disable colors in output.
Chris@13: 
Chris@13: EOL;
Chris@13:                 exit($usageException === null ? 0 : 1);
Chris@13:             }
Chris@13: 
Chris@13:             // Handle --version
Chris@13:             if ($input->getOption('version')) {
Chris@13:                 echo $shell->getVersion() . PHP_EOL;
Chris@13:                 exit(0);
Chris@13:             }
Chris@13: 
Chris@13:             // Pass additional arguments to Shell as 'includes'
Chris@13:             $shell->setIncludes($input->getArgument('include'));
Chris@13: 
Chris@13:             try {
Chris@13:                 // And go!
Chris@13:                 $shell->run();
Chris@13:             } catch (\Exception $e) {
Chris@13:                 echo $e->getMessage() . PHP_EOL;
Chris@13: 
Chris@13:                 // @todo this triggers the "exited unexpectedly" logic in the
Chris@13:                 // ForkingLoop, so we can't exit(1) after starting the shell...
Chris@13:                 // fix this :)
Chris@13: 
Chris@13:                 // exit(1);
Chris@13:             }
Chris@13:         };
Chris@13:     }
Chris@13: }