QuestionHelper.php 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Console\Helper;
  11. use Symfony\Component\Console\Exception\RuntimeException;
  12. use Symfony\Component\Console\Formatter\OutputFormatter;
  13. use Symfony\Component\Console\Formatter\OutputFormatterStyle;
  14. use Symfony\Component\Console\Input\InputInterface;
  15. use Symfony\Component\Console\Input\StreamableInputInterface;
  16. use Symfony\Component\Console\Output\ConsoleOutputInterface;
  17. use Symfony\Component\Console\Output\ConsoleSectionOutput;
  18. use Symfony\Component\Console\Output\OutputInterface;
  19. use Symfony\Component\Console\Question\ChoiceQuestion;
  20. use Symfony\Component\Console\Question\Question;
  21. /**
  22. * The QuestionHelper class provides helpers to interact with the user.
  23. *
  24. * @author Fabien Potencier <fabien@symfony.com>
  25. */
  26. class QuestionHelper extends Helper
  27. {
  28. private $inputStream;
  29. private static $shell;
  30. private static $stty;
  31. /**
  32. * Asks a question to the user.
  33. *
  34. * @return mixed The user answer
  35. *
  36. * @throws RuntimeException If there is no data to read in the input stream
  37. */
  38. public function ask(InputInterface $input, OutputInterface $output, Question $question)
  39. {
  40. if ($output instanceof ConsoleOutputInterface) {
  41. $output = $output->getErrorOutput();
  42. }
  43. if (!$input->isInteractive()) {
  44. $default = $question->getDefault();
  45. if (null === $default) {
  46. return $default;
  47. }
  48. if ($validator = $question->getValidator()) {
  49. return \call_user_func($question->getValidator(), $default);
  50. } elseif ($question instanceof ChoiceQuestion) {
  51. $choices = $question->getChoices();
  52. if (!$question->isMultiselect()) {
  53. return isset($choices[$default]) ? $choices[$default] : $default;
  54. }
  55. $default = explode(',', $default);
  56. foreach ($default as $k => $v) {
  57. $v = trim($v);
  58. $default[$k] = isset($choices[$v]) ? $choices[$v] : $v;
  59. }
  60. }
  61. return $default;
  62. }
  63. if ($input instanceof StreamableInputInterface && $stream = $input->getStream()) {
  64. $this->inputStream = $stream;
  65. }
  66. if (!$question->getValidator()) {
  67. return $this->doAsk($output, $question);
  68. }
  69. $interviewer = function () use ($output, $question) {
  70. return $this->doAsk($output, $question);
  71. };
  72. return $this->validateAttempts($interviewer, $output, $question);
  73. }
  74. /**
  75. * {@inheritdoc}
  76. */
  77. public function getName()
  78. {
  79. return 'question';
  80. }
  81. /**
  82. * Prevents usage of stty.
  83. */
  84. public static function disableStty()
  85. {
  86. self::$stty = false;
  87. }
  88. /**
  89. * Asks the question to the user.
  90. *
  91. * @return bool|mixed|string|null
  92. *
  93. * @throws RuntimeException In case the fallback is deactivated and the response cannot be hidden
  94. */
  95. private function doAsk(OutputInterface $output, Question $question)
  96. {
  97. $this->writePrompt($output, $question);
  98. $inputStream = $this->inputStream ?: STDIN;
  99. $autocomplete = $question->getAutocompleterValues();
  100. if (null === $autocomplete || !$this->hasSttyAvailable()) {
  101. $ret = false;
  102. if ($question->isHidden()) {
  103. try {
  104. $ret = trim($this->getHiddenResponse($output, $inputStream));
  105. } catch (RuntimeException $e) {
  106. if (!$question->isHiddenFallback()) {
  107. throw $e;
  108. }
  109. }
  110. }
  111. if (false === $ret) {
  112. $ret = fgets($inputStream, 4096);
  113. if (false === $ret) {
  114. throw new RuntimeException('Aborted.');
  115. }
  116. $ret = trim($ret);
  117. }
  118. } else {
  119. $ret = trim($this->autocomplete($output, $question, $inputStream, \is_array($autocomplete) ? $autocomplete : iterator_to_array($autocomplete, false)));
  120. }
  121. if ($output instanceof ConsoleSectionOutput) {
  122. $output->addContent($ret);
  123. }
  124. $ret = \strlen($ret) > 0 ? $ret : $question->getDefault();
  125. if ($normalizer = $question->getNormalizer()) {
  126. return $normalizer($ret);
  127. }
  128. return $ret;
  129. }
  130. /**
  131. * Outputs the question prompt.
  132. */
  133. protected function writePrompt(OutputInterface $output, Question $question)
  134. {
  135. $message = $question->getQuestion();
  136. if ($question instanceof ChoiceQuestion) {
  137. $maxWidth = max(array_map([$this, 'strlen'], array_keys($question->getChoices())));
  138. $messages = (array) $question->getQuestion();
  139. foreach ($question->getChoices() as $key => $value) {
  140. $width = $maxWidth - $this->strlen($key);
  141. $messages[] = ' [<info>'.$key.str_repeat(' ', $width).'</info>] '.$value;
  142. }
  143. $output->writeln($messages);
  144. $message = $question->getPrompt();
  145. }
  146. $output->write($message);
  147. }
  148. /**
  149. * Outputs an error message.
  150. */
  151. protected function writeError(OutputInterface $output, \Exception $error)
  152. {
  153. if (null !== $this->getHelperSet() && $this->getHelperSet()->has('formatter')) {
  154. $message = $this->getHelperSet()->get('formatter')->formatBlock($error->getMessage(), 'error');
  155. } else {
  156. $message = '<error>'.$error->getMessage().'</error>';
  157. }
  158. $output->writeln($message);
  159. }
  160. /**
  161. * Autocompletes a question.
  162. *
  163. * @param OutputInterface $output
  164. * @param Question $question
  165. * @param resource $inputStream
  166. */
  167. private function autocomplete(OutputInterface $output, Question $question, $inputStream, array $autocomplete): string
  168. {
  169. $fullChoice = '';
  170. $ret = '';
  171. $i = 0;
  172. $ofs = -1;
  173. $matches = $autocomplete;
  174. $numMatches = \count($matches);
  175. $sttyMode = shell_exec('stty -g');
  176. // Disable icanon (so we can fread each keypress) and echo (we'll do echoing here instead)
  177. shell_exec('stty -icanon -echo');
  178. // Add highlighted text style
  179. $output->getFormatter()->setStyle('hl', new OutputFormatterStyle('black', 'white'));
  180. // Read a keypress
  181. while (!feof($inputStream)) {
  182. $c = fread($inputStream, 1);
  183. // as opposed to fgets(), fread() returns an empty string when the stream content is empty, not false.
  184. if (false === $c || ('' === $ret && '' === $c && null === $question->getDefault())) {
  185. shell_exec(sprintf('stty %s', $sttyMode));
  186. throw new RuntimeException('Aborted.');
  187. } elseif ("\177" === $c) { // Backspace Character
  188. if (0 === $numMatches && 0 !== $i) {
  189. --$i;
  190. $fullChoice = substr($fullChoice, 0, -1);
  191. // Move cursor backwards
  192. $output->write("\033[1D");
  193. }
  194. if (0 === $i) {
  195. $ofs = -1;
  196. $matches = $autocomplete;
  197. $numMatches = \count($matches);
  198. } else {
  199. $numMatches = 0;
  200. }
  201. // Pop the last character off the end of our string
  202. $ret = substr($ret, 0, $i);
  203. } elseif ("\033" === $c) {
  204. // Did we read an escape sequence?
  205. $c .= fread($inputStream, 2);
  206. // A = Up Arrow. B = Down Arrow
  207. if (isset($c[2]) && ('A' === $c[2] || 'B' === $c[2])) {
  208. if ('A' === $c[2] && -1 === $ofs) {
  209. $ofs = 0;
  210. }
  211. if (0 === $numMatches) {
  212. continue;
  213. }
  214. $ofs += ('A' === $c[2]) ? -1 : 1;
  215. $ofs = ($numMatches + $ofs) % $numMatches;
  216. }
  217. } elseif (\ord($c) < 32) {
  218. if ("\t" === $c || "\n" === $c) {
  219. if ($numMatches > 0 && -1 !== $ofs) {
  220. $ret = $matches[$ofs];
  221. // Echo out remaining chars for current match
  222. $remainingCharacters = substr($ret, \strlen(trim($this->mostRecentlyEnteredValue($fullChoice))));
  223. $output->write($remainingCharacters);
  224. $fullChoice .= $remainingCharacters;
  225. $i = \strlen($fullChoice);
  226. }
  227. if ("\n" === $c) {
  228. $output->write($c);
  229. break;
  230. }
  231. $numMatches = 0;
  232. }
  233. continue;
  234. } else {
  235. if ("\x80" <= $c) {
  236. $c .= fread($inputStream, ["\xC0" => 1, "\xD0" => 1, "\xE0" => 2, "\xF0" => 3][$c & "\xF0"]);
  237. }
  238. $output->write($c);
  239. $ret .= $c;
  240. $fullChoice .= $c;
  241. ++$i;
  242. $tempRet = $ret;
  243. if ($question instanceof ChoiceQuestion && $question->isMultiselect()) {
  244. $tempRet = $this->mostRecentlyEnteredValue($fullChoice);
  245. }
  246. $numMatches = 0;
  247. $ofs = 0;
  248. foreach ($autocomplete as $value) {
  249. // If typed characters match the beginning chunk of value (e.g. [AcmeDe]moBundle)
  250. if (0 === strpos($value, $tempRet)) {
  251. $matches[$numMatches++] = $value;
  252. }
  253. }
  254. }
  255. // Erase characters from cursor to end of line
  256. $output->write("\033[K");
  257. if ($numMatches > 0 && -1 !== $ofs) {
  258. // Save cursor position
  259. $output->write("\0337");
  260. // Write highlighted text, complete the partially entered response
  261. $charactersEntered = \strlen(trim($this->mostRecentlyEnteredValue($fullChoice)));
  262. $output->write('<hl>'.OutputFormatter::escapeTrailingBackslash(substr($matches[$ofs], $charactersEntered)).'</hl>');
  263. // Restore cursor position
  264. $output->write("\0338");
  265. }
  266. }
  267. // Reset stty so it behaves normally again
  268. shell_exec(sprintf('stty %s', $sttyMode));
  269. return $fullChoice;
  270. }
  271. private function mostRecentlyEnteredValue($entered)
  272. {
  273. // Determine the most recent value that the user entered
  274. if (false === strpos($entered, ',')) {
  275. return $entered;
  276. }
  277. $choices = explode(',', $entered);
  278. if (\strlen($lastChoice = trim($choices[\count($choices) - 1])) > 0) {
  279. return $lastChoice;
  280. }
  281. return $entered;
  282. }
  283. /**
  284. * Gets a hidden response from user.
  285. *
  286. * @param OutputInterface $output An Output instance
  287. * @param resource $inputStream The handler resource
  288. *
  289. * @throws RuntimeException In case the fallback is deactivated and the response cannot be hidden
  290. */
  291. private function getHiddenResponse(OutputInterface $output, $inputStream): string
  292. {
  293. if ('\\' === \DIRECTORY_SEPARATOR) {
  294. $exe = __DIR__.'/../Resources/bin/hiddeninput.exe';
  295. // handle code running from a phar
  296. if ('phar:' === substr(__FILE__, 0, 5)) {
  297. $tmpExe = sys_get_temp_dir().'/hiddeninput.exe';
  298. copy($exe, $tmpExe);
  299. $exe = $tmpExe;
  300. }
  301. $value = rtrim(shell_exec($exe));
  302. $output->writeln('');
  303. if (isset($tmpExe)) {
  304. unlink($tmpExe);
  305. }
  306. return $value;
  307. }
  308. if ($this->hasSttyAvailable()) {
  309. $sttyMode = shell_exec('stty -g');
  310. shell_exec('stty -echo');
  311. $value = fgets($inputStream, 4096);
  312. shell_exec(sprintf('stty %s', $sttyMode));
  313. if (false === $value) {
  314. throw new RuntimeException('Aborted.');
  315. }
  316. $value = trim($value);
  317. $output->writeln('');
  318. return $value;
  319. }
  320. if (false !== $shell = $this->getShell()) {
  321. $readCmd = 'csh' === $shell ? 'set mypassword = $<' : 'read -r mypassword';
  322. $command = sprintf("/usr/bin/env %s -c 'stty -echo; %s; stty echo; echo \$mypassword'", $shell, $readCmd);
  323. $value = rtrim(shell_exec($command));
  324. $output->writeln('');
  325. return $value;
  326. }
  327. throw new RuntimeException('Unable to hide the response.');
  328. }
  329. /**
  330. * Validates an attempt.
  331. *
  332. * @param callable $interviewer A callable that will ask for a question and return the result
  333. * @param OutputInterface $output An Output instance
  334. * @param Question $question A Question instance
  335. *
  336. * @return mixed The validated response
  337. *
  338. * @throws \Exception In case the max number of attempts has been reached and no valid response has been given
  339. */
  340. private function validateAttempts(callable $interviewer, OutputInterface $output, Question $question)
  341. {
  342. $error = null;
  343. $attempts = $question->getMaxAttempts();
  344. while (null === $attempts || $attempts--) {
  345. if (null !== $error) {
  346. $this->writeError($output, $error);
  347. }
  348. try {
  349. return $question->getValidator()($interviewer());
  350. } catch (RuntimeException $e) {
  351. throw $e;
  352. } catch (\Exception $error) {
  353. }
  354. }
  355. throw $error;
  356. }
  357. /**
  358. * Returns a valid unix shell.
  359. *
  360. * @return string|bool The valid shell name, false in case no valid shell is found
  361. */
  362. private function getShell()
  363. {
  364. if (null !== self::$shell) {
  365. return self::$shell;
  366. }
  367. self::$shell = false;
  368. if (file_exists('/usr/bin/env')) {
  369. // handle other OSs with bash/zsh/ksh/csh if available to hide the answer
  370. $test = "/usr/bin/env %s -c 'echo OK' 2> /dev/null";
  371. foreach (['bash', 'zsh', 'ksh', 'csh'] as $sh) {
  372. if ('OK' === rtrim(shell_exec(sprintf($test, $sh)))) {
  373. self::$shell = $sh;
  374. break;
  375. }
  376. }
  377. }
  378. return self::$shell;
  379. }
  380. /**
  381. * Returns whether Stty is available or not.
  382. */
  383. private function hasSttyAvailable(): bool
  384. {
  385. if (null !== self::$stty) {
  386. return self::$stty;
  387. }
  388. exec('stty 2>&1', $output, $exitcode);
  389. return self::$stty = 0 === $exitcode;
  390. }
  391. }