123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899 |
- <?php
- /*
- * This file is part of Psy Shell.
- *
- * (c) 2012-2023 Justin Hileman
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Psy;
- use Psy\Exception\DeprecatedException;
- use Psy\Exception\RuntimeException;
- use Psy\ExecutionLoop\ProcessForker;
- use Psy\Output\OutputPager;
- use Psy\Output\ShellOutput;
- use Psy\Output\Theme;
- use Psy\TabCompletion\AutoCompleter;
- use Psy\VarDumper\Presenter;
- use Psy\VersionUpdater\Checker;
- use Psy\VersionUpdater\GitHubChecker;
- use Psy\VersionUpdater\IntervalChecker;
- use Psy\VersionUpdater\NoopChecker;
- use Symfony\Component\Console\Formatter\OutputFormatterStyle;
- use Symfony\Component\Console\Input\InputInterface;
- use Symfony\Component\Console\Input\InputOption;
- use Symfony\Component\Console\Output\OutputInterface;
- /**
- * The Psy Shell configuration.
- */
- class Configuration
- {
- const COLOR_MODE_AUTO = 'auto';
- const COLOR_MODE_FORCED = 'forced';
- const COLOR_MODE_DISABLED = 'disabled';
- const INTERACTIVE_MODE_AUTO = 'auto';
- const INTERACTIVE_MODE_FORCED = 'forced';
- const INTERACTIVE_MODE_DISABLED = 'disabled';
- const VERBOSITY_QUIET = 'quiet';
- const VERBOSITY_NORMAL = 'normal';
- const VERBOSITY_VERBOSE = 'verbose';
- const VERBOSITY_VERY_VERBOSE = 'very_verbose';
- const VERBOSITY_DEBUG = 'debug';
- private static $AVAILABLE_OPTIONS = [
- 'codeCleaner',
- 'colorMode',
- 'configDir',
- 'dataDir',
- 'defaultIncludes',
- 'eraseDuplicates',
- 'errorLoggingLevel',
- 'forceArrayIndexes',
- 'formatterStyles',
- 'historyFile',
- 'historySize',
- 'interactiveMode',
- 'manualDbFile',
- 'pager',
- 'prompt',
- 'rawOutput',
- 'requireSemicolons',
- 'runtimeDir',
- 'startupMessage',
- 'strictTypes',
- 'theme',
- 'updateCheck',
- 'useBracketedPaste',
- 'usePcntl',
- 'useReadline',
- 'useTabCompletion',
- 'useUnicode',
- 'verbosity',
- 'warnOnMultipleConfigs',
- 'yolo',
- ];
- private $defaultIncludes;
- private $configDir;
- private $dataDir;
- private $runtimeDir;
- private $configFile;
- /** @var string|false */
- private $historyFile;
- private $historySize;
- private $eraseDuplicates;
- private $manualDbFile;
- private $hasReadline;
- private $useReadline;
- private $useBracketedPaste;
- private $hasPcntl;
- private $usePcntl;
- private $newCommands = [];
- private $pipedInput;
- private $pipedOutput;
- private $rawOutput = false;
- private $requireSemicolons = false;
- private $strictTypes = false;
- private $useUnicode;
- private $useTabCompletion;
- private $newMatchers = [];
- private $errorLoggingLevel = \E_ALL;
- private $warnOnMultipleConfigs = false;
- private $colorMode = self::COLOR_MODE_AUTO;
- private $interactiveMode = self::INTERACTIVE_MODE_AUTO;
- private $updateCheck;
- private $startupMessage;
- private $forceArrayIndexes = false;
- /** @deprecated */
- private $formatterStyles = [];
- private $verbosity = self::VERBOSITY_NORMAL;
- private $yolo = false;
- /** @var Theme */
- private $theme;
- // services
- private $readline;
- /** @var ShellOutput */
- private $output;
- private $shell;
- private $cleaner;
- private $pager;
- private $manualDb;
- private $presenter;
- private $autoCompleter;
- private $checker;
- /** @deprecated */
- private $prompt;
- private $configPaths;
- /**
- * Construct a Configuration instance.
- *
- * Optionally, supply an array of configuration values to load.
- *
- * @param array $config Optional array of configuration values
- */
- public function __construct(array $config = [])
- {
- $this->configPaths = new ConfigPaths();
- // explicit configFile option
- if (isset($config['configFile'])) {
- $this->configFile = $config['configFile'];
- } elseif (isset($_SERVER['PSYSH_CONFIG']) && $_SERVER['PSYSH_CONFIG']) {
- $this->configFile = $_SERVER['PSYSH_CONFIG'];
- } elseif (\PHP_SAPI === 'cli-server' && ($configFile = \getenv('PSYSH_CONFIG'))) {
- $this->configFile = $configFile;
- }
- // legacy baseDir option
- if (isset($config['baseDir'])) {
- $msg = "The 'baseDir' configuration option is deprecated; ".
- "please specify 'configDir' and 'dataDir' options instead";
- throw new DeprecatedException($msg);
- }
- unset($config['configFile'], $config['baseDir']);
- // go go gadget, config!
- $this->loadConfig($config);
- $this->init();
- }
- /**
- * Construct a Configuration object from Symfony Console input.
- *
- * This is great for adding psysh-compatible command line options to framework- or app-specific
- * wrappers.
- *
- * $input should already be bound to an appropriate InputDefinition (see self::getInputOptions
- * if you want to build your own) before calling this method. It's not required, but things work
- * a lot better if we do.
- *
- * @see self::getInputOptions
- *
- * @throws \InvalidArgumentException
- *
- * @param InputInterface $input
- */
- public static function fromInput(InputInterface $input): self
- {
- $config = new self(['configFile' => self::getConfigFileFromInput($input)]);
- // Handle --color and --no-color (and --ansi and --no-ansi aliases)
- if (self::getOptionFromInput($input, ['color', 'ansi'])) {
- $config->setColorMode(self::COLOR_MODE_FORCED);
- } elseif (self::getOptionFromInput($input, ['no-color', 'no-ansi'])) {
- $config->setColorMode(self::COLOR_MODE_DISABLED);
- }
- // Handle verbosity options
- if ($verbosity = self::getVerbosityFromInput($input)) {
- $config->setVerbosity($verbosity);
- }
- // Handle interactive mode
- if (self::getOptionFromInput($input, ['interactive', 'interaction'], ['-a', '-i'])) {
- $config->setInteractiveMode(self::INTERACTIVE_MODE_FORCED);
- } elseif (self::getOptionFromInput($input, ['no-interactive', 'no-interaction'], ['-n'])) {
- $config->setInteractiveMode(self::INTERACTIVE_MODE_DISABLED);
- }
- // Handle --compact
- if (self::getOptionFromInput($input, ['compact'])) {
- $config->setTheme('compact');
- }
- // Handle --raw-output
- // @todo support raw output with interactive input?
- if (!$config->getInputInteractive()) {
- if (self::getOptionFromInput($input, ['raw-output'], ['-r'])) {
- $config->setRawOutput(true);
- }
- }
- // Handle --yolo
- if (self::getOptionFromInput($input, ['yolo'])) {
- $config->setYolo(true);
- }
- return $config;
- }
- /**
- * Get the desired config file from the given input.
- *
- * @return string|null config file path, or null if none is specified
- */
- private static function getConfigFileFromInput(InputInterface $input)
- {
- // Best case, input is properly bound and validated.
- if ($input->hasOption('config')) {
- return $input->getOption('config');
- }
- return $input->getParameterOption('--config', null, true) ?: $input->getParameterOption('-c', null, true);
- }
- /**
- * Get a boolean option from the given input.
- *
- * This helper allows fallback for unbound and unvalidated input. It's not perfect--for example,
- * it can't deal with several short options squished together--but it's better than falling over
- * any time someone gives us unbound input.
- *
- * @return bool true if the option (or an alias) is present
- */
- private static function getOptionFromInput(InputInterface $input, array $names, array $otherParams = []): bool
- {
- // Best case, input is properly bound and validated.
- foreach ($names as $name) {
- if ($input->hasOption($name) && $input->getOption($name)) {
- return true;
- }
- }
- foreach ($names as $name) {
- $otherParams[] = '--'.$name;
- }
- foreach ($otherParams as $name) {
- if ($input->hasParameterOption($name, true)) {
- return true;
- }
- }
- return false;
- }
- /**
- * Get the desired verbosity from the given input.
- *
- * This is a bit more complext than the other options parsers. It handles `--quiet` and
- * `--verbose`, along with their short aliases, and fancy things like `-vvv`.
- *
- * @return string|null configuration constant, or null if no verbosity option is specified
- */
- private static function getVerbosityFromInput(InputInterface $input)
- {
- // --quiet wins!
- if (self::getOptionFromInput($input, ['quiet'], ['-q'])) {
- return self::VERBOSITY_QUIET;
- }
- // Best case, input is properly bound and validated.
- //
- // Note that if the `--verbose` option is incorrectly defined as `VALUE_NONE` rather than
- // `VALUE_OPTIONAL` (as it is in Symfony Console by default) it doesn't actually work with
- // multiple verbosity levels as it claims.
- //
- // We can detect this by checking whether the the value === true, and fall back to unbound
- // parsing for this option.
- if ($input->hasOption('verbose') && $input->getOption('verbose') !== true) {
- switch ($input->getOption('verbose')) {
- case '-1':
- return self::VERBOSITY_QUIET;
- case '0': // explicitly normal, overrides config file default
- return self::VERBOSITY_NORMAL;
- case '1':
- case null: // `--verbose` and `-v`
- return self::VERBOSITY_VERBOSE;
- case '2':
- case 'v': // `-vv`
- return self::VERBOSITY_VERY_VERBOSE;
- case '3':
- case 'vv': // `-vvv`
- return self::VERBOSITY_DEBUG;
- default: // implicitly normal, config file default wins
- return;
- }
- }
- // quiet and normal have to come before verbose, because it eats everything else.
- if ($input->hasParameterOption('--verbose=-1', true) || $input->getParameterOption('--verbose', false, true) === '-1') {
- return self::VERBOSITY_QUIET;
- }
- if ($input->hasParameterOption('--verbose=0', true) || $input->getParameterOption('--verbose', false, true) === '0') {
- return self::VERBOSITY_NORMAL;
- }
- // `-vvv`, `-vv` and `-v` have to come in descending length order, because `hasParameterOption` matches prefixes.
- if ($input->hasParameterOption('-vvv', true) || $input->hasParameterOption('--verbose=3', true) || $input->getParameterOption('--verbose', false, true) === '3') {
- return self::VERBOSITY_DEBUG;
- }
- if ($input->hasParameterOption('-vv', true) || $input->hasParameterOption('--verbose=2', true) || $input->getParameterOption('--verbose', false, true) === '2') {
- return self::VERBOSITY_VERY_VERBOSE;
- }
- if ($input->hasParameterOption('-v', true) || $input->hasParameterOption('--verbose=1', true) || $input->hasParameterOption('--verbose', true)) {
- return self::VERBOSITY_VERBOSE;
- }
- }
- /**
- * Get a list of input options expected when initializing Configuration via input.
- *
- * @see self::fromInput
- *
- * @return InputOption[]
- */
- public static function getInputOptions(): array
- {
- return [
- new InputOption('config', 'c', InputOption::VALUE_REQUIRED, 'Use an alternate PsySH config file location.'),
- new InputOption('cwd', null, InputOption::VALUE_REQUIRED, 'Use an alternate working directory.'),
- new InputOption('color', null, InputOption::VALUE_NONE, 'Force colors in output.'),
- new InputOption('no-color', null, InputOption::VALUE_NONE, 'Disable colors in output.'),
- // --ansi and --no-ansi aliases to match Symfony, Composer, etc.
- new InputOption('ansi', null, InputOption::VALUE_NONE, 'Force colors in output.'),
- new InputOption('no-ansi', null, InputOption::VALUE_NONE, 'Disable colors in output.'),
- new InputOption('quiet', 'q', InputOption::VALUE_NONE, 'Shhhhhh.'),
- new InputOption('verbose', 'v|vv|vvv', InputOption::VALUE_OPTIONAL, 'Increase the verbosity of messages.', '0'),
- new InputOption('compact', null, InputOption::VALUE_NONE, 'Run PsySH with compact output.'),
- new InputOption('interactive', 'i|a', InputOption::VALUE_NONE, 'Force PsySH to run in interactive mode.'),
- new InputOption('no-interactive', 'n', InputOption::VALUE_NONE, 'Run PsySH without interactive input. Requires input from stdin.'),
- // --interaction and --no-interaction aliases for compatibility with Symfony, Composer, etc
- new InputOption('interaction', null, InputOption::VALUE_NONE, 'Force PsySH to run in interactive mode.'),
- new InputOption('no-interaction', null, InputOption::VALUE_NONE, 'Run PsySH without interactive input. Requires input from stdin.'),
- new InputOption('raw-output', 'r', InputOption::VALUE_NONE, 'Print var_export-style return values (for non-interactive input)'),
- new InputOption('self-update', 'u', InputOption::VALUE_NONE, 'Update to the latest version'),
- new InputOption('yolo', null, InputOption::VALUE_NONE, 'Run PsySH with minimal input validation. You probably don\'t want this.'),
- ];
- }
- /**
- * Initialize the configuration.
- *
- * This checks for the presence of Readline and Pcntl extensions.
- *
- * If a config file is available, it will be loaded and merged with the current config.
- *
- * If no custom config file was specified and a local project config file
- * is available, it will be loaded and merged with the current config.
- */
- public function init()
- {
- // feature detection
- $this->hasReadline = \function_exists('readline');
- $this->hasPcntl = ProcessForker::isSupported();
- if ($configFile = $this->getConfigFile()) {
- $this->loadConfigFile($configFile);
- }
- if (!$this->configFile && $localConfig = $this->getLocalConfigFile()) {
- $this->loadConfigFile($localConfig);
- }
- $this->configPaths->overrideDirs([
- 'configDir' => $this->configDir,
- 'dataDir' => $this->dataDir,
- 'runtimeDir' => $this->runtimeDir,
- ]);
- }
- /**
- * Get the current PsySH config file.
- *
- * If a `configFile` option was passed to the Configuration constructor,
- * this file will be returned. If not, all possible config directories will
- * be searched, and the first `config.php` or `rc.php` file which exists
- * will be returned.
- *
- * If you're trying to decide where to put your config file, pick
- *
- * ~/.config/psysh/config.php
- *
- * @return string|null
- */
- public function getConfigFile()
- {
- if (isset($this->configFile)) {
- return $this->configFile;
- }
- $files = $this->configPaths->configFiles(['config.php', 'rc.php']);
- if (!empty($files)) {
- if ($this->warnOnMultipleConfigs && \count($files) > 1) {
- $msg = \sprintf('Multiple configuration files found: %s. Using %s', \implode(', ', $files), $files[0]);
- \trigger_error($msg, \E_USER_NOTICE);
- }
- return $files[0];
- }
- }
- /**
- * Get the local PsySH config file.
- *
- * Searches for a project specific config file `.psysh.php` in the current
- * working directory.
- *
- * @return string|null
- */
- public function getLocalConfigFile()
- {
- $localConfig = \getcwd().'/.psysh.php';
- if (@\is_file($localConfig)) {
- return $localConfig;
- }
- }
- /**
- * Load configuration values from an array of options.
- *
- * @param array $options
- */
- public function loadConfig(array $options)
- {
- foreach (self::$AVAILABLE_OPTIONS as $option) {
- if (isset($options[$option])) {
- $method = 'set'.\ucfirst($option);
- $this->$method($options[$option]);
- }
- }
- // legacy `tabCompletion` option
- if (isset($options['tabCompletion'])) {
- $msg = '`tabCompletion` is deprecated; use `useTabCompletion` instead.';
- @\trigger_error($msg, \E_USER_DEPRECATED);
- $this->setUseTabCompletion($options['tabCompletion']);
- }
- foreach (['commands', 'matchers', 'casters'] as $option) {
- if (isset($options[$option])) {
- $method = 'add'.\ucfirst($option);
- $this->$method($options[$option]);
- }
- }
- // legacy `tabCompletionMatchers` option
- if (isset($options['tabCompletionMatchers'])) {
- $msg = '`tabCompletionMatchers` is deprecated; use `matchers` instead.';
- @\trigger_error($msg, \E_USER_DEPRECATED);
- $this->addMatchers($options['tabCompletionMatchers']);
- }
- }
- /**
- * Load a configuration file (default: `$HOME/.config/psysh/config.php`).
- *
- * This configuration instance will be available to the config file as $config.
- * The config file may directly manipulate the configuration, or may return
- * an array of options which will be merged with the current configuration.
- *
- * @throws \InvalidArgumentException if the config file does not exist or returns a non-array result
- *
- * @param string $file
- */
- public function loadConfigFile(string $file)
- {
- if (!\is_file($file)) {
- throw new \InvalidArgumentException(\sprintf('Invalid configuration file specified, %s does not exist', $file));
- }
- $__psysh_config_file__ = $file;
- $load = function ($config) use ($__psysh_config_file__) {
- $result = require $__psysh_config_file__;
- if ($result !== 1) {
- return $result;
- }
- };
- $result = $load($this);
- if (!empty($result)) {
- if (\is_array($result)) {
- $this->loadConfig($result);
- } else {
- throw new \InvalidArgumentException('Psy Shell configuration must return an array of options');
- }
- }
- }
- /**
- * Set files to be included by default at the start of each shell session.
- *
- * @param array $includes
- */
- public function setDefaultIncludes(array $includes = [])
- {
- $this->defaultIncludes = $includes;
- }
- /**
- * Get files to be included by default at the start of each shell session.
- *
- * @return string[]
- */
- public function getDefaultIncludes(): array
- {
- return $this->defaultIncludes ?: [];
- }
- /**
- * Set the shell's config directory location.
- *
- * @param string $dir
- */
- public function setConfigDir(string $dir)
- {
- $this->configDir = (string) $dir;
- $this->configPaths->overrideDirs([
- 'configDir' => $this->configDir,
- 'dataDir' => $this->dataDir,
- 'runtimeDir' => $this->runtimeDir,
- ]);
- }
- /**
- * Get the current configuration directory, if any is explicitly set.
- *
- * @return string|null
- */
- public function getConfigDir()
- {
- return $this->configDir;
- }
- /**
- * Set the shell's data directory location.
- *
- * @param string $dir
- */
- public function setDataDir(string $dir)
- {
- $this->dataDir = (string) $dir;
- $this->configPaths->overrideDirs([
- 'configDir' => $this->configDir,
- 'dataDir' => $this->dataDir,
- 'runtimeDir' => $this->runtimeDir,
- ]);
- }
- /**
- * Get the current data directory, if any is explicitly set.
- *
- * @return string|null
- */
- public function getDataDir()
- {
- return $this->dataDir;
- }
- /**
- * Set the shell's temporary directory location.
- *
- * @param string $dir
- */
- public function setRuntimeDir(string $dir)
- {
- $this->runtimeDir = (string) $dir;
- $this->configPaths->overrideDirs([
- 'configDir' => $this->configDir,
- 'dataDir' => $this->dataDir,
- 'runtimeDir' => $this->runtimeDir,
- ]);
- }
- /**
- * Get the shell's temporary directory location.
- *
- * Defaults to `/psysh` inside the system's temp dir unless explicitly
- * overridden.
- *
- * @throws RuntimeException if no temporary directory is set and it is not possible to create one
- */
- public function getRuntimeDir(): string
- {
- $runtimeDir = $this->configPaths->runtimeDir();
- if (!\is_dir($runtimeDir)) {
- if (!@\mkdir($runtimeDir, 0700, true)) {
- throw new RuntimeException(\sprintf('Unable to create PsySH runtime directory. Make sure PHP is able to write to %s in order to continue.', \dirname($runtimeDir)));
- }
- }
- return $runtimeDir;
- }
- /**
- * Set the readline history file path.
- *
- * @param string $file
- */
- public function setHistoryFile(string $file)
- {
- $this->historyFile = ConfigPaths::touchFileWithMkdir($file);
- }
- /**
- * Get the readline history file path.
- *
- * Defaults to `/history` inside the shell's base config dir unless
- * explicitly overridden.
- */
- public function getHistoryFile(): string
- {
- if (isset($this->historyFile)) {
- return $this->historyFile;
- }
- $files = $this->configPaths->configFiles(['psysh_history', 'history']);
- if (!empty($files)) {
- if ($this->warnOnMultipleConfigs && \count($files) > 1) {
- $msg = \sprintf('Multiple history files found: %s. Using %s', \implode(', ', $files), $files[0]);
- \trigger_error($msg, \E_USER_NOTICE);
- }
- $this->setHistoryFile($files[0]);
- } else {
- // fallback: create our own history file
- $this->setHistoryFile($this->configPaths->currentConfigDir().'/psysh_history');
- }
- return $this->historyFile;
- }
- /**
- * Set the readline max history size.
- *
- * @param int $value
- */
- public function setHistorySize(int $value)
- {
- $this->historySize = (int) $value;
- }
- /**
- * Get the readline max history size.
- *
- * @return int
- */
- public function getHistorySize()
- {
- return $this->historySize;
- }
- /**
- * Sets whether readline erases old duplicate history entries.
- *
- * @param bool $value
- */
- public function setEraseDuplicates(bool $value)
- {
- $this->eraseDuplicates = (bool) $value;
- }
- /**
- * Get whether readline erases old duplicate history entries.
- *
- * @return bool|null
- */
- public function getEraseDuplicates()
- {
- return $this->eraseDuplicates;
- }
- /**
- * Get a temporary file of type $type for process $pid.
- *
- * The file will be created inside the current temporary directory.
- *
- * @see self::getRuntimeDir
- *
- * @param string $type
- * @param int $pid
- *
- * @return string Temporary file name
- */
- public function getTempFile(string $type, int $pid): string
- {
- return \tempnam($this->getRuntimeDir(), $type.'_'.$pid.'_');
- }
- /**
- * Get a filename suitable for a FIFO pipe of $type for process $pid.
- *
- * The pipe will be created inside the current temporary directory.
- *
- * @param string $type
- * @param int $pid
- *
- * @return string Pipe name
- */
- public function getPipe(string $type, int $pid): string
- {
- return \sprintf('%s/%s_%s', $this->getRuntimeDir(), $type, $pid);
- }
- /**
- * Check whether this PHP instance has Readline available.
- *
- * @return bool True if Readline is available
- */
- public function hasReadline(): bool
- {
- return $this->hasReadline;
- }
- /**
- * Enable or disable Readline usage.
- *
- * @param bool $useReadline
- */
- public function setUseReadline(bool $useReadline)
- {
- $this->useReadline = (bool) $useReadline;
- }
- /**
- * Check whether to use Readline.
- *
- * If `setUseReadline` as been set to true, but Readline is not actually
- * available, this will return false.
- *
- * @return bool True if the current Shell should use Readline
- */
- public function useReadline(): bool
- {
- return isset($this->useReadline) ? ($this->hasReadline && $this->useReadline) : $this->hasReadline;
- }
- /**
- * Set the Psy Shell readline service.
- *
- * @param Readline\Readline $readline
- */
- public function setReadline(Readline\Readline $readline)
- {
- $this->readline = $readline;
- }
- /**
- * Get the Psy Shell readline service.
- *
- * By default, this service uses (in order of preference):
- *
- * * GNU Readline
- * * Libedit
- * * A transient array-based readline emulation.
- *
- * @return Readline\Readline
- */
- public function getReadline(): Readline\Readline
- {
- if (!isset($this->readline)) {
- $className = $this->getReadlineClass();
- $this->readline = new $className(
- $this->getHistoryFile(),
- $this->getHistorySize(),
- $this->getEraseDuplicates()
- );
- }
- return $this->readline;
- }
- /**
- * Get the appropriate Readline implementation class name.
- *
- * @see self::getReadline
- */
- private function getReadlineClass(): string
- {
- if ($this->useReadline()) {
- if (Readline\GNUReadline::isSupported()) {
- return Readline\GNUReadline::class;
- } elseif (Readline\Libedit::isSupported()) {
- return Readline\Libedit::class;
- }
- }
- if (Readline\Userland::isSupported()) {
- return Readline\Userland::class;
- }
- return Readline\Transient::class;
- }
- /**
- * Enable or disable bracketed paste.
- *
- * Note that this only works with readline (not libedit) integration for now.
- *
- * @param bool $useBracketedPaste
- */
- public function setUseBracketedPaste(bool $useBracketedPaste)
- {
- $this->useBracketedPaste = (bool) $useBracketedPaste;
- }
- /**
- * Check whether to use bracketed paste with readline.
- *
- * When this works, it's magical. Tabs in pastes don't try to autcomplete.
- * Newlines in paste don't execute code until you get to the end. It makes
- * readline act like you'd expect when pasting.
- *
- * But it often (usually?) does not work. And when it doesn't, it just spews
- * escape codes all over the place and generally makes things ugly :(
- *
- * If `useBracketedPaste` has been set to true, but the current readline
- * implementation is anything besides GNU readline, this will return false.
- *
- * @return bool True if the shell should use bracketed paste
- */
- public function useBracketedPaste(): bool
- {
- $readlineClass = $this->getReadlineClass();
- return $this->useBracketedPaste && $readlineClass::supportsBracketedPaste();
- // @todo mebbe turn this on by default some day?
- // return $readlineClass::supportsBracketedPaste() && $this->useBracketedPaste !== false;
- }
- /**
- * Check whether this PHP instance has Pcntl available.
- *
- * @return bool True if Pcntl is available
- */
- public function hasPcntl(): bool
- {
- return $this->hasPcntl;
- }
- /**
- * Enable or disable Pcntl usage.
- *
- * @param bool $usePcntl
- */
- public function setUsePcntl(bool $usePcntl)
- {
- $this->usePcntl = (bool) $usePcntl;
- }
- /**
- * Check whether to use Pcntl.
- *
- * If `setUsePcntl` has been set to true, but Pcntl is not actually
- * available, this will return false.
- *
- * @return bool True if the current Shell should use Pcntl
- */
- public function usePcntl(): bool
- {
- if (!isset($this->usePcntl)) {
- // Unless pcntl is explicitly *enabled*, don't use it while XDebug is debugging.
- // See https://github.com/bobthecow/psysh/issues/742
- if (\function_exists('xdebug_is_debugger_active') && \xdebug_is_debugger_active()) {
- return false;
- }
- return $this->hasPcntl;
- }
- return $this->hasPcntl && $this->usePcntl;
- }
- /**
- * Check whether to use raw output.
- *
- * This is set by the --raw-output (-r) flag, and really only makes sense
- * when non-interactive, e.g. executing stdin.
- *
- * @return bool true if raw output is enabled
- */
- public function rawOutput(): bool
- {
- return $this->rawOutput;
- }
- /**
- * Enable or disable raw output.
- *
- * @param bool $rawOutput
- */
- public function setRawOutput(bool $rawOutput)
- {
- $this->rawOutput = (bool) $rawOutput;
- }
- /**
- * Enable or disable strict requirement of semicolons.
- *
- * @see self::requireSemicolons()
- *
- * @param bool $requireSemicolons
- */
- public function setRequireSemicolons(bool $requireSemicolons)
- {
- $this->requireSemicolons = (bool) $requireSemicolons;
- }
- /**
- * Check whether to require semicolons on all statements.
- *
- * By default, PsySH will automatically insert semicolons at the end of
- * statements if they're missing. To strictly require semicolons, set
- * `requireSemicolons` to true.
- */
- public function requireSemicolons(): bool
- {
- return $this->requireSemicolons;
- }
- /**
- * Enable or disable strict types enforcement.
- */
- public function setStrictTypes($strictTypes)
- {
- $this->strictTypes = (bool) $strictTypes;
- }
- /**
- * Check whether to enforce strict types.
- */
- public function strictTypes(): bool
- {
- return $this->strictTypes;
- }
- /**
- * Enable or disable Unicode in PsySH specific output.
- *
- * Note that this does not disable Unicode output in general, it just makes
- * it so PsySH won't output any itself.
- *
- * @param bool $useUnicode
- */
- public function setUseUnicode(bool $useUnicode)
- {
- $this->useUnicode = (bool) $useUnicode;
- }
- /**
- * Check whether to use Unicode in PsySH specific output.
- *
- * Note that this does not disable Unicode output in general, it just makes
- * it so PsySH won't output any itself.
- */
- public function useUnicode(): bool
- {
- if (isset($this->useUnicode)) {
- return $this->useUnicode;
- }
- // @todo detect `chsh` != 65001 on Windows and return false
- return true;
- }
- /**
- * Set the error logging level.
- *
- * @see self::errorLoggingLevel
- *
- * @param int $errorLoggingLevel
- */
- public function setErrorLoggingLevel($errorLoggingLevel)
- {
- $this->errorLoggingLevel = (\E_ALL | \E_STRICT) & $errorLoggingLevel;
- }
- /**
- * Get the current error logging level.
- *
- * By default, PsySH will automatically log all errors, regardless of the
- * current `error_reporting` level.
- *
- * Set `errorLoggingLevel` to 0 to prevent logging non-thrown errors. Set it
- * to any valid error_reporting value to log only errors which match that
- * level.
- *
- * http://php.net/manual/en/function.error-reporting.php
- */
- public function errorLoggingLevel(): int
- {
- return $this->errorLoggingLevel;
- }
- /**
- * Set a CodeCleaner service instance.
- *
- * @param CodeCleaner $cleaner
- */
- public function setCodeCleaner(CodeCleaner $cleaner)
- {
- $this->cleaner = $cleaner;
- }
- /**
- * Get a CodeCleaner service instance.
- *
- * If none has been explicitly defined, this will create a new instance.
- */
- public function getCodeCleaner(): CodeCleaner
- {
- if (!isset($this->cleaner)) {
- $this->cleaner = new CodeCleaner(null, null, null, $this->yolo(), $this->strictTypes());
- }
- return $this->cleaner;
- }
- /**
- * Enable or disable running PsySH without input validation.
- *
- * You don't want this.
- */
- public function setYolo($yolo)
- {
- $this->yolo = (bool) $yolo;
- }
- /**
- * Check whether to disable input validation.
- */
- public function yolo(): bool
- {
- return $this->yolo;
- }
- /**
- * Enable or disable tab completion.
- *
- * @param bool $useTabCompletion
- */
- public function setUseTabCompletion(bool $useTabCompletion)
- {
- $this->useTabCompletion = (bool) $useTabCompletion;
- }
- /**
- * @deprecated Call `setUseTabCompletion` instead
- *
- * @param bool $useTabCompletion
- */
- public function setTabCompletion(bool $useTabCompletion)
- {
- @\trigger_error('`setTabCompletion` is deprecated; call `setUseTabCompletion` instead.', \E_USER_DEPRECATED);
- $this->setUseTabCompletion($useTabCompletion);
- }
- /**
- * Check whether to use tab completion.
- *
- * If `setUseTabCompletion` has been set to true, but readline is not
- * actually available, this will return false.
- *
- * @return bool True if the current Shell should use tab completion
- */
- public function useTabCompletion(): bool
- {
- return isset($this->useTabCompletion) ? ($this->hasReadline && $this->useTabCompletion) : $this->hasReadline;
- }
- /**
- * @deprecated Call `useTabCompletion` instead
- */
- public function getTabCompletion(): bool
- {
- @\trigger_error('`getTabCompletion` is deprecated; call `useTabCompletion` instead.', \E_USER_DEPRECATED);
- return $this->useTabCompletion();
- }
- /**
- * Set the Shell Output service.
- *
- * @param ShellOutput $output
- */
- public function setOutput(ShellOutput $output)
- {
- $this->output = $output;
- $this->pipedOutput = null; // Reset cached pipe info
- if (isset($this->theme)) {
- $output->setTheme($this->theme);
- }
- $this->applyFormatterStyles();
- }
- /**
- * Get a Shell Output service instance.
- *
- * If none has been explicitly provided, this will create a new instance
- * with the configured verbosity and output pager supplied by self::getPager
- *
- * @see self::verbosity
- * @see self::getPager
- */
- public function getOutput(): ShellOutput
- {
- if (!isset($this->output)) {
- $this->setOutput(new ShellOutput(
- $this->getOutputVerbosity(),
- null,
- null,
- $this->getPager() ?: null,
- $this->theme()
- ));
- // This is racy because `getOutputDecorated` needs access to the
- // output stream to figure out if it's piped or not, so create it
- // first, then update after we have a stream.
- $decorated = $this->getOutputDecorated();
- if ($decorated !== null) {
- $this->output->setDecorated($decorated);
- }
- }
- return $this->output;
- }
- /**
- * Get the decoration (i.e. color) setting for the Shell Output service.
- *
- * @return bool|null 3-state boolean corresponding to the current color mode
- */
- public function getOutputDecorated()
- {
- switch ($this->colorMode()) {
- case self::COLOR_MODE_FORCED:
- return true;
- case self::COLOR_MODE_DISABLED:
- return false;
- case self::COLOR_MODE_AUTO:
- default:
- return $this->outputIsPiped() ? false : null;
- }
- }
- /**
- * Get the interactive setting for shell input.
- */
- public function getInputInteractive(): bool
- {
- switch ($this->interactiveMode()) {
- case self::INTERACTIVE_MODE_FORCED:
- return true;
- case self::INTERACTIVE_MODE_DISABLED:
- return false;
- case self::INTERACTIVE_MODE_AUTO:
- default:
- return !$this->inputIsPiped();
- }
- }
- /**
- * Set the OutputPager service.
- *
- * If a string is supplied, a ProcOutputPager will be used which shells out
- * to the specified command.
- *
- * `cat` is special-cased to use the PassthruPager directly.
- *
- * @throws \InvalidArgumentException if $pager is not a string or OutputPager instance
- *
- * @param string|OutputPager|false $pager
- */
- public function setPager($pager)
- {
- if ($pager === null || $pager === false || $pager === 'cat') {
- $pager = false;
- }
- if ($pager !== false && !\is_string($pager) && !$pager instanceof OutputPager) {
- throw new \InvalidArgumentException('Unexpected pager instance');
- }
- $this->pager = $pager;
- }
- /**
- * Get an OutputPager instance or a command for an external Proc pager.
- *
- * If no Pager has been explicitly provided, and Pcntl is available, this
- * will default to `cli.pager` ini value, falling back to `which less`.
- *
- * @return string|OutputPager|false
- */
- public function getPager()
- {
- if (!isset($this->pager) && $this->usePcntl()) {
- if (\getenv('TERM') === 'dumb') {
- return false;
- }
- if ($pager = \ini_get('cli.pager')) {
- // use the default pager
- $this->pager = $pager;
- } elseif ($less = $this->configPaths->which('less')) {
- // check for the presence of less...
- $this->pager = $less.' -R -F -X';
- }
- }
- return $this->pager;
- }
- /**
- * Set the Shell AutoCompleter service.
- *
- * @param AutoCompleter $autoCompleter
- */
- public function setAutoCompleter(AutoCompleter $autoCompleter)
- {
- $this->autoCompleter = $autoCompleter;
- }
- /**
- * Get an AutoCompleter service instance.
- */
- public function getAutoCompleter(): AutoCompleter
- {
- if (!isset($this->autoCompleter)) {
- $this->autoCompleter = new AutoCompleter();
- }
- return $this->autoCompleter;
- }
- /**
- * @deprecated Nothing should be using this anymore
- */
- public function getTabCompletionMatchers(): array
- {
- @\trigger_error('`getTabCompletionMatchers` is no longer used.', \E_USER_DEPRECATED);
- return [];
- }
- /**
- * Add tab completion matchers to the AutoCompleter.
- *
- * This will buffer new matchers in the event that the Shell has not yet
- * been instantiated. This allows the user to specify matchers in their
- * config rc file, despite the fact that their file is needed in the Shell
- * constructor.
- *
- * @param array $matchers
- */
- public function addMatchers(array $matchers)
- {
- $this->newMatchers = \array_merge($this->newMatchers, $matchers);
- if (isset($this->shell)) {
- $this->doAddMatchers();
- }
- }
- /**
- * Internal method for adding tab completion matchers. This will set any new
- * matchers once a Shell is available.
- */
- private function doAddMatchers()
- {
- if (!empty($this->newMatchers)) {
- $this->shell->addMatchers($this->newMatchers);
- $this->newMatchers = [];
- }
- }
- /**
- * @deprecated Use `addMatchers` instead
- *
- * @param array $matchers
- */
- public function addTabCompletionMatchers(array $matchers)
- {
- @\trigger_error('`addTabCompletionMatchers` is deprecated; call `addMatchers` instead.', \E_USER_DEPRECATED);
- $this->addMatchers($matchers);
- }
- /**
- * Add commands to the Shell.
- *
- * This will buffer new commands in the event that the Shell has not yet
- * been instantiated. This allows the user to specify commands in their
- * config rc file, despite the fact that their file is needed in the Shell
- * constructor.
- *
- * @param array $commands
- */
- public function addCommands(array $commands)
- {
- $this->newCommands = \array_merge($this->newCommands, $commands);
- if (isset($this->shell)) {
- $this->doAddCommands();
- }
- }
- /**
- * Internal method for adding commands. This will set any new commands once
- * a Shell is available.
- */
- private function doAddCommands()
- {
- if (!empty($this->newCommands)) {
- $this->shell->addCommands($this->newCommands);
- $this->newCommands = [];
- }
- }
- /**
- * Set the Shell backreference and add any new commands to the Shell.
- *
- * @param Shell $shell
- */
- public function setShell(Shell $shell)
- {
- $this->shell = $shell;
- $this->doAddCommands();
- $this->doAddMatchers();
- }
- /**
- * Set the PHP manual database file.
- *
- * This file should be an SQLite database generated from the phpdoc source
- * with the `bin/build_manual` script.
- *
- * @param string $filename
- */
- public function setManualDbFile(string $filename)
- {
- $this->manualDbFile = (string) $filename;
- }
- /**
- * Get the current PHP manual database file.
- *
- * @return string|null Default: '~/.local/share/psysh/php_manual.sqlite'
- */
- public function getManualDbFile()
- {
- if (isset($this->manualDbFile)) {
- return $this->manualDbFile;
- }
- $files = $this->configPaths->dataFiles(['php_manual.sqlite']);
- if (!empty($files)) {
- if ($this->warnOnMultipleConfigs && \count($files) > 1) {
- $msg = \sprintf('Multiple manual database files found: %s. Using %s', \implode(', ', $files), $files[0]);
- \trigger_error($msg, \E_USER_NOTICE);
- }
- return $this->manualDbFile = $files[0];
- }
- }
- /**
- * Get a PHP manual database connection.
- *
- * @return \PDO|null
- */
- public function getManualDb()
- {
- if (!isset($this->manualDb)) {
- $dbFile = $this->getManualDbFile();
- if ($dbFile !== null && \is_file($dbFile)) {
- try {
- $this->manualDb = new \PDO('sqlite:'.$dbFile);
- } catch (\PDOException $e) {
- if ($e->getMessage() === 'could not find driver') {
- throw new RuntimeException('SQLite PDO driver not found', 0, $e);
- } else {
- throw $e;
- }
- }
- }
- }
- return $this->manualDb;
- }
- /**
- * Add an array of casters definitions.
- *
- * @param array $casters
- */
- public function addCasters(array $casters)
- {
- $this->getPresenter()->addCasters($casters);
- }
- /**
- * Get the Presenter service.
- */
- public function getPresenter(): Presenter
- {
- if (!isset($this->presenter)) {
- $this->presenter = new Presenter($this->getOutput()->getFormatter(), $this->forceArrayIndexes());
- }
- return $this->presenter;
- }
- /**
- * Enable or disable warnings on multiple configuration or data files.
- *
- * @see self::warnOnMultipleConfigs()
- *
- * @param bool $warnOnMultipleConfigs
- */
- public function setWarnOnMultipleConfigs(bool $warnOnMultipleConfigs)
- {
- $this->warnOnMultipleConfigs = (bool) $warnOnMultipleConfigs;
- }
- /**
- * Check whether to warn on multiple configuration or data files.
- *
- * By default, PsySH will use the file with highest precedence, and will
- * silently ignore all others. With this enabled, a warning will be emitted
- * (but not an exception thrown) if multiple configuration or data files
- * are found.
- *
- * This will default to true in a future release, but is false for now.
- */
- public function warnOnMultipleConfigs(): bool
- {
- return $this->warnOnMultipleConfigs;
- }
- /**
- * Set the current color mode.
- *
- * @throws \InvalidArgumentException if the color mode isn't auto, forced or disabled
- *
- * @param string $colorMode
- */
- public function setColorMode(string $colorMode)
- {
- $validColorModes = [
- self::COLOR_MODE_AUTO,
- self::COLOR_MODE_FORCED,
- self::COLOR_MODE_DISABLED,
- ];
- if (!\in_array($colorMode, $validColorModes)) {
- throw new \InvalidArgumentException('Invalid color mode: '.$colorMode);
- }
- $this->colorMode = $colorMode;
- }
- /**
- * Get the current color mode.
- */
- public function colorMode(): string
- {
- return $this->colorMode;
- }
- /**
- * Set the shell's interactive mode.
- *
- * @throws \InvalidArgumentException if interactive mode isn't disabled, forced, or auto
- *
- * @param string $interactiveMode
- */
- public function setInteractiveMode(string $interactiveMode)
- {
- $validInteractiveModes = [
- self::INTERACTIVE_MODE_AUTO,
- self::INTERACTIVE_MODE_FORCED,
- self::INTERACTIVE_MODE_DISABLED,
- ];
- if (!\in_array($interactiveMode, $validInteractiveModes)) {
- throw new \InvalidArgumentException('Invalid interactive mode: '.$interactiveMode);
- }
- $this->interactiveMode = $interactiveMode;
- }
- /**
- * Get the current interactive mode.
- */
- public function interactiveMode(): string
- {
- return $this->interactiveMode;
- }
- /**
- * Set an update checker service instance.
- *
- * @param Checker $checker
- */
- public function setChecker(Checker $checker)
- {
- $this->checker = $checker;
- }
- /**
- * Get an update checker service instance.
- *
- * If none has been explicitly defined, this will create a new instance.
- */
- public function getChecker(): Checker
- {
- if (!isset($this->checker)) {
- $interval = $this->getUpdateCheck();
- switch ($interval) {
- case Checker::ALWAYS:
- $this->checker = new GitHubChecker();
- break;
- case Checker::DAILY:
- case Checker::WEEKLY:
- case Checker::MONTHLY:
- $checkFile = $this->getUpdateCheckCacheFile();
- if ($checkFile === false) {
- $this->checker = new NoopChecker();
- } else {
- $this->checker = new IntervalChecker($checkFile, $interval);
- }
- break;
- case Checker::NEVER:
- $this->checker = new NoopChecker();
- break;
- }
- }
- return $this->checker;
- }
- /**
- * Get the current update check interval.
- *
- * One of 'always', 'daily', 'weekly', 'monthly' or 'never'. If none is
- * explicitly set, default to 'weekly'.
- */
- public function getUpdateCheck(): string
- {
- return isset($this->updateCheck) ? $this->updateCheck : Checker::WEEKLY;
- }
- /**
- * Set the update check interval.
- *
- * @throws \InvalidArgumentException if the update check interval is unknown
- *
- * @param string $interval
- */
- public function setUpdateCheck(string $interval)
- {
- $validIntervals = [
- Checker::ALWAYS,
- Checker::DAILY,
- Checker::WEEKLY,
- Checker::MONTHLY,
- Checker::NEVER,
- ];
- if (!\in_array($interval, $validIntervals)) {
- throw new \InvalidArgumentException('Invalid update check interval: '.$interval);
- }
- $this->updateCheck = $interval;
- }
- /**
- * Get a cache file path for the update checker.
- *
- * @return string|false Return false if config file/directory is not writable
- */
- public function getUpdateCheckCacheFile()
- {
- return ConfigPaths::touchFileWithMkdir($this->configPaths->currentConfigDir().'/update_check.json');
- }
- /**
- * Set the startup message.
- *
- * @param string $message
- */
- public function setStartupMessage(string $message)
- {
- $this->startupMessage = $message;
- }
- /**
- * Get the startup message.
- *
- * @return string|null
- */
- public function getStartupMessage()
- {
- return $this->startupMessage;
- }
- /**
- * Set the prompt.
- *
- * @deprecated The `prompt` configuration has been replaced by Themes and support will
- * eventually be removed. In the meantime, prompt is applied first by the Theme, then overridden
- * by any explicitly defined prompt.
- *
- * Note that providing a prompt but not a theme config will implicitly use the `classic` theme.
- */
- public function setPrompt(string $prompt)
- {
- $this->prompt = $prompt;
- if (isset($this->theme)) {
- $this->theme->setPrompt($prompt);
- }
- }
- /**
- * Get the prompt.
- *
- * @return string|null
- */
- public function getPrompt()
- {
- return $this->prompt;
- }
- /**
- * Get the force array indexes.
- */
- public function forceArrayIndexes(): bool
- {
- return $this->forceArrayIndexes;
- }
- /**
- * Set the force array indexes.
- *
- * @param bool $forceArrayIndexes
- */
- public function setForceArrayIndexes(bool $forceArrayIndexes)
- {
- $this->forceArrayIndexes = $forceArrayIndexes;
- }
- /**
- * Set the current output Theme.
- *
- * @param Theme|string|array $theme Theme (or Theme config)
- */
- public function setTheme($theme)
- {
- if (!$theme instanceof Theme) {
- $theme = new Theme($theme);
- }
- $this->theme = $theme;
- if (isset($this->prompt)) {
- $this->theme->setPrompt($this->prompt);
- }
- if (isset($this->output)) {
- $this->output->setTheme($theme);
- $this->applyFormatterStyles();
- }
- }
- /**
- * Get the current output Theme.
- */
- public function theme(): Theme
- {
- if (!isset($this->theme)) {
- // If a prompt is explicitly set, and a theme is not, base it on the `classic` theme.
- $this->theme = $this->prompt ? new Theme('classic') : new Theme();
- }
- if (isset($this->prompt)) {
- $this->theme->setPrompt($this->prompt);
- }
- return $this->theme;
- }
- /**
- * Set the shell output formatter styles.
- *
- * Accepts a map from style name to [fg, bg, options], for example:
- *
- * [
- * 'error' => ['white', 'red', ['bold']],
- * 'warning' => ['black', 'yellow'],
- * ]
- *
- * Foreground, background or options can be null, or even omitted entirely.
- *
- * @deprecated The `formatterStyles` configuration has been replaced by Themes and support will
- * eventually be removed. In the meantime, styles are applied first by the Theme, then
- * overridden by any explicitly defined formatter styles.
- */
- public function setFormatterStyles(array $formatterStyles)
- {
- foreach ($formatterStyles as $name => $style) {
- $this->formatterStyles[$name] = new OutputFormatterStyle(...$style);
- }
- if (isset($this->output)) {
- $this->applyFormatterStyles();
- }
- }
- /**
- * Internal method for applying output formatter style customization.
- *
- * This is called on initialization of the shell output, and again if the
- * formatter styles config is updated.
- *
- * @deprecated The `formatterStyles` configuration has been replaced by Themes and support will
- * eventually be removed. In the meantime, styles are applied first by the Theme, then
- * overridden by any explicitly defined formatter styles.
- */
- private function applyFormatterStyles()
- {
- $formatter = $this->output->getFormatter();
- foreach ($this->formatterStyles as $name => $style) {
- $formatter->setStyle($name, $style);
- }
- $errorFormatter = $this->output->getErrorOutput()->getFormatter();
- foreach (Theme::ERROR_STYLES as $name) {
- if (isset($this->formatterStyles[$name])) {
- $errorFormatter->setStyle($name, $this->formatterStyles[$name]);
- }
- }
- }
- /**
- * Get the configured output verbosity.
- */
- public function verbosity(): string
- {
- return $this->verbosity;
- }
- /**
- * Set the shell output verbosity.
- *
- * Accepts OutputInterface verbosity constants.
- *
- * @throws \InvalidArgumentException if verbosity level is invalid
- *
- * @param string $verbosity
- */
- public function setVerbosity(string $verbosity)
- {
- $validVerbosityLevels = [
- self::VERBOSITY_QUIET,
- self::VERBOSITY_NORMAL,
- self::VERBOSITY_VERBOSE,
- self::VERBOSITY_VERY_VERBOSE,
- self::VERBOSITY_DEBUG,
- ];
- if (!\in_array($verbosity, $validVerbosityLevels)) {
- throw new \InvalidArgumentException('Invalid verbosity level: '.$verbosity);
- }
- $this->verbosity = $verbosity;
- if (isset($this->output)) {
- $this->output->setVerbosity($this->getOutputVerbosity());
- }
- }
- /**
- * Map the verbosity configuration to OutputInterface verbosity constants.
- *
- * @return int OutputInterface verbosity level
- */
- public function getOutputVerbosity(): int
- {
- switch ($this->verbosity()) {
- case self::VERBOSITY_QUIET:
- return OutputInterface::VERBOSITY_QUIET;
- case self::VERBOSITY_VERBOSE:
- return OutputInterface::VERBOSITY_VERBOSE;
- case self::VERBOSITY_VERY_VERBOSE:
- return OutputInterface::VERBOSITY_VERY_VERBOSE;
- case self::VERBOSITY_DEBUG:
- return OutputInterface::VERBOSITY_DEBUG;
- case self::VERBOSITY_NORMAL:
- default:
- return OutputInterface::VERBOSITY_NORMAL;
- }
- }
- /**
- * Guess whether stdin is piped.
- *
- * This is mostly useful for deciding whether to use non-interactive mode.
- */
- public function inputIsPiped(): bool
- {
- if ($this->pipedInput === null) {
- $this->pipedInput = \defined('STDIN') && self::looksLikeAPipe(\STDIN);
- }
- return $this->pipedInput;
- }
- /**
- * Guess whether shell output is piped.
- *
- * This is mostly useful for deciding whether to use non-decorated output.
- */
- public function outputIsPiped(): bool
- {
- if ($this->pipedOutput === null) {
- $this->pipedOutput = self::looksLikeAPipe($this->getOutput()->getStream());
- }
- return $this->pipedOutput;
- }
- /**
- * Guess whether an input or output stream is piped.
- *
- * @param resource|int $stream
- */
- private static function looksLikeAPipe($stream): bool
- {
- if (\function_exists('posix_isatty')) {
- return !\posix_isatty($stream);
- }
- $stat = \fstat($stream);
- $mode = $stat['mode'] & 0170000;
- return $mode === 0010000 || $mode === 0040000 || $mode === 0100000 || $mode === 0120000;
- }
- }
|