-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
[Console] Ensure terminal is usable after termination signal #61861
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
144 changes: 144 additions & 0 deletions
144
src/Symfony/Component/Console/Helper/TerminalInputHelper.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| <?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; | ||
|
|
||
| /** | ||
| * TerminalInputHelper stops Ctrl-C and similar signals from leaving the terminal in | ||
| * an unusable state if its settings have been modified when reading user input. | ||
| * This can be an issue on non-Windows platforms. | ||
| * | ||
| * Usage: | ||
| * | ||
| * $inputHelper = new TerminalInputHelper($inputStream); | ||
| * | ||
| * ...change terminal settings | ||
| * | ||
| * // Wait for input before all input reads | ||
| * $inputHelper->waitForInput(); | ||
| * | ||
| * ...read input | ||
| * | ||
| * // Call finish to restore terminal settings and signal handlers | ||
| * $inputHelper->finish() | ||
| * | ||
| * @internal | ||
| */ | ||
| final class TerminalInputHelper | ||
| { | ||
| /** @var resource */ | ||
| private $inputStream; | ||
| private bool $isStdin; | ||
| private string $initialState; | ||
| private int $signalToKill = 0; | ||
| private array $signalHandlers = []; | ||
| private array $targetSignals = []; | ||
|
|
||
| /** | ||
| * @param resource $inputStream | ||
| * | ||
| * @throws \RuntimeException If unable to read terminal settings | ||
| */ | ||
| public function __construct($inputStream) | ||
| { | ||
| if (!\is_string($state = shell_exec('stty -g'))) { | ||
| throw new \RuntimeException('Unable to read the terminal settings.'); | ||
| } | ||
| $this->inputStream = $inputStream; | ||
| $this->initialState = $state; | ||
| $this->isStdin = 'php://stdin' === stream_get_meta_data($inputStream)['uri']; | ||
| $this->createSignalHandlers(); | ||
| } | ||
|
|
||
| /** | ||
| * Waits for input and terminates if sent a default signal. | ||
| */ | ||
| public function waitForInput(): void | ||
| { | ||
| if ($this->isStdin) { | ||
| $r = [$this->inputStream]; | ||
| $w = []; | ||
|
|
||
| // Allow signal handlers to run, either before Enter is pressed | ||
| // when icanon is enabled, or a single character is entered when | ||
| // icanon is disabled | ||
| while (0 === @stream_select($r, $w, $w, 0, 100)) { | ||
| $r = [$this->inputStream]; | ||
| } | ||
| } | ||
| $this->checkForKillSignal(); | ||
| } | ||
|
|
||
| /** | ||
| * Restores terminal state and signal handlers. | ||
| */ | ||
| public function finish(): void | ||
| { | ||
| // Safeguard in case an unhandled kill signal exists | ||
| $this->checkForKillSignal(); | ||
| shell_exec('stty '.$this->initialState); | ||
| $this->signalToKill = 0; | ||
|
|
||
| foreach ($this->signalHandlers as $signal => $originalHandler) { | ||
| pcntl_signal($signal, $originalHandler); | ||
| } | ||
| $this->signalHandlers = []; | ||
| $this->targetSignals = []; | ||
| } | ||
|
|
||
| private function createSignalHandlers(): void | ||
| { | ||
| if (!\function_exists('pcntl_async_signals') || !\function_exists('pcntl_signal')) { | ||
| return; | ||
| } | ||
|
|
||
| pcntl_async_signals(true); | ||
| $this->targetSignals = [\SIGINT, \SIGQUIT, \SIGTERM]; | ||
|
|
||
| foreach ($this->targetSignals as $signal) { | ||
| $this->signalHandlers[$signal] = pcntl_signal_get_handler($signal); | ||
|
|
||
| pcntl_signal($signal, function ($signal) { | ||
| // Save current state, then restore to initial state | ||
| $currentState = shell_exec('stty -g'); | ||
| shell_exec('stty '.$this->initialState); | ||
| $originalHandler = $this->signalHandlers[$signal]; | ||
|
|
||
| if (\is_callable($originalHandler)) { | ||
| $originalHandler($signal); | ||
| // Handler did not exit, so restore to current state | ||
| shell_exec('stty '.$currentState); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| // Not a callable, so SIG_DFL or SIG_IGN | ||
| if (\SIG_DFL === $originalHandler) { | ||
| $this->signalToKill = $signal; | ||
| } | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| private function checkForKillSignal(): void | ||
| { | ||
| if (\in_array($this->signalToKill, $this->targetSignals, true)) { | ||
| // Try posix_kill | ||
| if (\function_exists('posix_kill')) { | ||
| pcntl_signal($this->signalToKill, \SIG_DFL); | ||
| posix_kill(getmypid(), $this->signalToKill); | ||
| } | ||
|
|
||
| // Best attempt fallback | ||
| exit(128 + $this->signalToKill); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 37 additions & 0 deletions
37
src/Symfony/Component/Console/Tests/Fixtures/application_sttyhelper.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <?php | ||
|
|
||
| use Symfony\Component\Console\Input\InputDefinition; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Input\InputOption; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
| use Symfony\Component\Console\Question\ChoiceQuestion; | ||
| use Symfony\Component\Console\Question\Question; | ||
| use Symfony\Component\Console\SingleCommandApplication; | ||
|
|
||
| $vendor = __DIR__; | ||
| while (!file_exists($vendor.'/vendor')) { | ||
| $vendor = dirname($vendor); | ||
| } | ||
| require $vendor.'/vendor/autoload.php'; | ||
|
|
||
| (new class extends SingleCommandApplication {}) | ||
| ->setDefinition(new InputDefinition([ | ||
| new InputOption('choice', null, InputOption::VALUE_NONE, ''), | ||
| new InputOption('hidden', null, InputOption::VALUE_NONE, ''), | ||
| ])) | ||
| ->setCode(function (InputInterface $input, OutputInterface $output) { | ||
| if ($input->getOption('choice')) { | ||
| $this->getHelper('question') | ||
| ->ask($input, $output, new ChoiceQuestion('😊', ['n'])); | ||
| } else { | ||
| $question = new Question('😊'); | ||
| $question->setHidden(true); | ||
| $this->getHelper('question') | ||
| ->ask($input, $output, $question); | ||
| } | ||
|
|
||
| return 0; | ||
| }) | ||
| ->run() | ||
|
|
||
| ; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.