4599afef86
This PR was squashed before being merged into the 3.3-dev branch (closes #20885).
Discussion
----------
[Console] Option to disable stty
| Q | A
| ------------- | ---
| Branch? |
| Bug fix? | no
| New feature? | yes
| BC breaks? | no
| Deprecations? | no
| Tests pass? |
| Fixed tickets |
| License | MIT
| Doc PR | reference to the documentation PR, if any
Shall fix problems in Windows based environments if e.g. git is installed and stty is therefore found but writes only cryptic rubbish into the cmd. In the case of console questions it is also possible that input can't be read properly by console component.
Commits
-------
a189a6c52e [Console] Option to disable stty
475 lines
14 KiB
PHP
475 lines
14 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Component\Console\Helper;
|
|
|
|
use Symfony\Component\Console\Exception\InvalidArgumentException;
|
|
use Symfony\Component\Console\Exception\RuntimeException;
|
|
use Symfony\Component\Console\Input\InputInterface;
|
|
use Symfony\Component\Console\Input\StreamableInputInterface;
|
|
use Symfony\Component\Console\Output\ConsoleOutputInterface;
|
|
use Symfony\Component\Console\Output\OutputInterface;
|
|
use Symfony\Component\Console\Formatter\OutputFormatterStyle;
|
|
use Symfony\Component\Console\Question\Question;
|
|
use Symfony\Component\Console\Question\ChoiceQuestion;
|
|
|
|
/**
|
|
* The QuestionHelper class provides helpers to interact with the user.
|
|
*
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
|
*/
|
|
class QuestionHelper extends Helper
|
|
{
|
|
private $inputStream;
|
|
private static $shell;
|
|
private static $stty;
|
|
|
|
/**
|
|
* Asks a question to the user.
|
|
*
|
|
* @param InputInterface $input An InputInterface instance
|
|
* @param OutputInterface $output An OutputInterface instance
|
|
* @param Question $question The question to ask
|
|
*
|
|
* @return mixed The user answer
|
|
*
|
|
* @throws RuntimeException If there is no data to read in the input stream
|
|
*/
|
|
public function ask(InputInterface $input, OutputInterface $output, Question $question)
|
|
{
|
|
if ($output instanceof ConsoleOutputInterface) {
|
|
$output = $output->getErrorOutput();
|
|
}
|
|
|
|
if (!$input->isInteractive()) {
|
|
return $question->getDefault();
|
|
}
|
|
|
|
if ($input instanceof StreamableInputInterface && $stream = $input->getStream()) {
|
|
$this->inputStream = $stream;
|
|
}
|
|
|
|
if (!$question->getValidator()) {
|
|
return $this->doAsk($output, $question);
|
|
}
|
|
|
|
$interviewer = function () use ($output, $question) {
|
|
return $this->doAsk($output, $question);
|
|
};
|
|
|
|
return $this->validateAttempts($interviewer, $output, $question);
|
|
}
|
|
|
|
/**
|
|
* Sets the input stream to read from when interacting with the user.
|
|
*
|
|
* This is mainly useful for testing purpose.
|
|
*
|
|
* @deprecated since version 3.2, to be removed in 4.0. Use
|
|
* StreamableInputInterface::setStream() instead.
|
|
*
|
|
* @param resource $stream The input stream
|
|
*
|
|
* @throws InvalidArgumentException In case the stream is not a resource
|
|
*/
|
|
public function setInputStream($stream)
|
|
{
|
|
@trigger_error(sprintf('The %s() method is deprecated since version 3.2 and will be removed in 4.0. Use %s::setStream() instead.', __METHOD__, StreamableInputInterface::class), E_USER_DEPRECATED);
|
|
|
|
if (!is_resource($stream)) {
|
|
throw new InvalidArgumentException('Input stream must be a valid resource.');
|
|
}
|
|
|
|
$this->inputStream = $stream;
|
|
}
|
|
|
|
/**
|
|
* Returns the helper's input stream.
|
|
*
|
|
* @deprecated since version 3.2, to be removed in 4.0. Use
|
|
* StreamableInputInterface::getStream() instead.
|
|
*
|
|
* @return resource
|
|
*/
|
|
public function getInputStream()
|
|
{
|
|
if (0 === func_num_args() || func_get_arg(0)) {
|
|
@trigger_error(sprintf('The %s() method is deprecated since version 3.2 and will be removed in 4.0. Use %s::getStream() instead.', __METHOD__, StreamableInputInterface::class), E_USER_DEPRECATED);
|
|
}
|
|
|
|
return $this->inputStream;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getName()
|
|
{
|
|
return 'question';
|
|
}
|
|
|
|
/**
|
|
* Prevents usage of stty.
|
|
*/
|
|
public static function disableStty()
|
|
{
|
|
self::$stty = false;
|
|
}
|
|
|
|
/**
|
|
* Asks the question to the user.
|
|
*
|
|
* @param OutputInterface $output
|
|
* @param Question $question
|
|
*
|
|
* @return bool|mixed|null|string
|
|
*
|
|
* @throws \Exception
|
|
* @throws \RuntimeException
|
|
*/
|
|
private function doAsk(OutputInterface $output, Question $question)
|
|
{
|
|
$this->writePrompt($output, $question);
|
|
|
|
$inputStream = $this->inputStream ?: STDIN;
|
|
$autocomplete = $question->getAutocompleterValues();
|
|
|
|
if (null === $autocomplete || !$this->hasSttyAvailable()) {
|
|
$ret = false;
|
|
if ($question->isHidden()) {
|
|
try {
|
|
$ret = trim($this->getHiddenResponse($output, $inputStream));
|
|
} catch (\RuntimeException $e) {
|
|
if (!$question->isHiddenFallback()) {
|
|
throw $e;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (false === $ret) {
|
|
$ret = fgets($inputStream, 4096);
|
|
if (false === $ret) {
|
|
throw new RuntimeException('Aborted');
|
|
}
|
|
$ret = trim($ret);
|
|
}
|
|
} else {
|
|
$ret = trim($this->autocomplete($output, $question, $inputStream));
|
|
}
|
|
|
|
$ret = strlen($ret) > 0 ? $ret : $question->getDefault();
|
|
|
|
if ($normalizer = $question->getNormalizer()) {
|
|
return $normalizer($ret);
|
|
}
|
|
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Outputs the question prompt.
|
|
*
|
|
* @param OutputInterface $output
|
|
* @param Question $question
|
|
*/
|
|
protected function writePrompt(OutputInterface $output, Question $question)
|
|
{
|
|
$message = $question->getQuestion();
|
|
|
|
if ($question instanceof ChoiceQuestion) {
|
|
$maxWidth = max(array_map(array($this, 'strlen'), array_keys($question->getChoices())));
|
|
|
|
$messages = (array) $question->getQuestion();
|
|
foreach ($question->getChoices() as $key => $value) {
|
|
$width = $maxWidth - $this->strlen($key);
|
|
$messages[] = ' [<info>'.$key.str_repeat(' ', $width).'</info>] '.$value;
|
|
}
|
|
|
|
$output->writeln($messages);
|
|
|
|
$message = $question->getPrompt();
|
|
}
|
|
|
|
$output->write($message);
|
|
}
|
|
|
|
/**
|
|
* Outputs an error message.
|
|
*
|
|
* @param OutputInterface $output
|
|
* @param \Exception $error
|
|
*/
|
|
protected function writeError(OutputInterface $output, \Exception $error)
|
|
{
|
|
if (null !== $this->getHelperSet() && $this->getHelperSet()->has('formatter')) {
|
|
$message = $this->getHelperSet()->get('formatter')->formatBlock($error->getMessage(), 'error');
|
|
} else {
|
|
$message = '<error>'.$error->getMessage().'</error>';
|
|
}
|
|
|
|
$output->writeln($message);
|
|
}
|
|
|
|
/**
|
|
* Autocompletes a question.
|
|
*
|
|
* @param OutputInterface $output
|
|
* @param Question $question
|
|
* @param resource $inputStream
|
|
*
|
|
* @return string
|
|
*/
|
|
private function autocomplete(OutputInterface $output, Question $question, $inputStream)
|
|
{
|
|
$autocomplete = $question->getAutocompleterValues();
|
|
$ret = '';
|
|
|
|
$i = 0;
|
|
$ofs = -1;
|
|
$matches = $autocomplete;
|
|
$numMatches = count($matches);
|
|
|
|
$sttyMode = shell_exec('stty -g');
|
|
|
|
// Disable icanon (so we can fread each keypress) and echo (we'll do echoing here instead)
|
|
shell_exec('stty -icanon -echo');
|
|
|
|
// Add highlighted text style
|
|
$output->getFormatter()->setStyle('hl', new OutputFormatterStyle('black', 'white'));
|
|
|
|
// Read a keypress
|
|
while (!feof($inputStream)) {
|
|
$c = fread($inputStream, 1);
|
|
|
|
// Backspace Character
|
|
if ("\177" === $c) {
|
|
if (0 === $numMatches && 0 !== $i) {
|
|
--$i;
|
|
// Move cursor backwards
|
|
$output->write("\033[1D");
|
|
}
|
|
|
|
if ($i === 0) {
|
|
$ofs = -1;
|
|
$matches = $autocomplete;
|
|
$numMatches = count($matches);
|
|
} else {
|
|
$numMatches = 0;
|
|
}
|
|
|
|
// Pop the last character off the end of our string
|
|
$ret = substr($ret, 0, $i);
|
|
} elseif ("\033" === $c) {
|
|
// Did we read an escape sequence?
|
|
$c .= fread($inputStream, 2);
|
|
|
|
// A = Up Arrow. B = Down Arrow
|
|
if (isset($c[2]) && ('A' === $c[2] || 'B' === $c[2])) {
|
|
if ('A' === $c[2] && -1 === $ofs) {
|
|
$ofs = 0;
|
|
}
|
|
|
|
if (0 === $numMatches) {
|
|
continue;
|
|
}
|
|
|
|
$ofs += ('A' === $c[2]) ? -1 : 1;
|
|
$ofs = ($numMatches + $ofs) % $numMatches;
|
|
}
|
|
} elseif (ord($c) < 32) {
|
|
if ("\t" === $c || "\n" === $c) {
|
|
if ($numMatches > 0 && -1 !== $ofs) {
|
|
$ret = $matches[$ofs];
|
|
// Echo out remaining chars for current match
|
|
$output->write(substr($ret, $i));
|
|
$i = strlen($ret);
|
|
}
|
|
|
|
if ("\n" === $c) {
|
|
$output->write($c);
|
|
break;
|
|
}
|
|
|
|
$numMatches = 0;
|
|
}
|
|
|
|
continue;
|
|
} else {
|
|
$output->write($c);
|
|
$ret .= $c;
|
|
++$i;
|
|
|
|
$numMatches = 0;
|
|
$ofs = 0;
|
|
|
|
foreach ($autocomplete as $value) {
|
|
// If typed characters match the beginning chunk of value (e.g. [AcmeDe]moBundle)
|
|
if (0 === strpos($value, $ret) && $i !== strlen($value)) {
|
|
$matches[$numMatches++] = $value;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Erase characters from cursor to end of line
|
|
$output->write("\033[K");
|
|
|
|
if ($numMatches > 0 && -1 !== $ofs) {
|
|
// Save cursor position
|
|
$output->write("\0337");
|
|
// Write highlighted text
|
|
$output->write('<hl>'.substr($matches[$ofs], $i).'</hl>');
|
|
// Restore cursor position
|
|
$output->write("\0338");
|
|
}
|
|
}
|
|
|
|
// Reset stty so it behaves normally again
|
|
shell_exec(sprintf('stty %s', $sttyMode));
|
|
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Gets a hidden response from user.
|
|
*
|
|
* @param OutputInterface $output An Output instance
|
|
* @param resource $inputStream The handler resource
|
|
*
|
|
* @return string The answer
|
|
*
|
|
* @throws RuntimeException In case the fallback is deactivated and the response cannot be hidden
|
|
*/
|
|
private function getHiddenResponse(OutputInterface $output, $inputStream)
|
|
{
|
|
if ('\\' === DIRECTORY_SEPARATOR) {
|
|
$exe = __DIR__.'/../Resources/bin/hiddeninput.exe';
|
|
|
|
// handle code running from a phar
|
|
if ('phar:' === substr(__FILE__, 0, 5)) {
|
|
$tmpExe = sys_get_temp_dir().'/hiddeninput.exe';
|
|
copy($exe, $tmpExe);
|
|
$exe = $tmpExe;
|
|
}
|
|
|
|
$value = rtrim(shell_exec($exe));
|
|
$output->writeln('');
|
|
|
|
if (isset($tmpExe)) {
|
|
unlink($tmpExe);
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
if ($this->hasSttyAvailable()) {
|
|
$sttyMode = shell_exec('stty -g');
|
|
|
|
shell_exec('stty -echo');
|
|
$value = fgets($inputStream, 4096);
|
|
shell_exec(sprintf('stty %s', $sttyMode));
|
|
|
|
if (false === $value) {
|
|
throw new RuntimeException('Aborted');
|
|
}
|
|
|
|
$value = trim($value);
|
|
$output->writeln('');
|
|
|
|
return $value;
|
|
}
|
|
|
|
if (false !== $shell = $this->getShell()) {
|
|
$readCmd = $shell === 'csh' ? 'set mypassword = $<' : 'read -r mypassword';
|
|
$command = sprintf("/usr/bin/env %s -c 'stty -echo; %s; stty echo; echo \$mypassword'", $shell, $readCmd);
|
|
$value = rtrim(shell_exec($command));
|
|
$output->writeln('');
|
|
|
|
return $value;
|
|
}
|
|
|
|
throw new RuntimeException('Unable to hide the response.');
|
|
}
|
|
|
|
/**
|
|
* Validates an attempt.
|
|
*
|
|
* @param callable $interviewer A callable that will ask for a question and return the result
|
|
* @param OutputInterface $output An Output instance
|
|
* @param Question $question A Question instance
|
|
*
|
|
* @return mixed The validated response
|
|
*
|
|
* @throws \Exception In case the max number of attempts has been reached and no valid response has been given
|
|
*/
|
|
private function validateAttempts(callable $interviewer, OutputInterface $output, Question $question)
|
|
{
|
|
$error = null;
|
|
$attempts = $question->getMaxAttempts();
|
|
while (null === $attempts || $attempts--) {
|
|
if (null !== $error) {
|
|
$this->writeError($output, $error);
|
|
}
|
|
|
|
try {
|
|
return call_user_func($question->getValidator(), $interviewer());
|
|
} catch (RuntimeException $e) {
|
|
throw $e;
|
|
} catch (\Exception $error) {
|
|
}
|
|
}
|
|
|
|
throw $error;
|
|
}
|
|
|
|
/**
|
|
* Returns a valid unix shell.
|
|
*
|
|
* @return string|bool The valid shell name, false in case no valid shell is found
|
|
*/
|
|
private function getShell()
|
|
{
|
|
if (null !== self::$shell) {
|
|
return self::$shell;
|
|
}
|
|
|
|
self::$shell = false;
|
|
|
|
if (file_exists('/usr/bin/env')) {
|
|
// handle other OSs with bash/zsh/ksh/csh if available to hide the answer
|
|
$test = "/usr/bin/env %s -c 'echo OK' 2> /dev/null";
|
|
foreach (array('bash', 'zsh', 'ksh', 'csh') as $sh) {
|
|
if ('OK' === rtrim(shell_exec(sprintf($test, $sh)))) {
|
|
self::$shell = $sh;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
return self::$shell;
|
|
}
|
|
|
|
/**
|
|
* Returns whether Stty is available or not.
|
|
*
|
|
* @return bool
|
|
*/
|
|
private function hasSttyAvailable()
|
|
{
|
|
if (null !== self::$stty) {
|
|
return self::$stty;
|
|
}
|
|
|
|
exec('stty 2>&1', $output, $exitcode);
|
|
|
|
return self::$stty = $exitcode === 0;
|
|
}
|
|
}
|