ConsoleOutput.php 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  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\Output;
  11. use Symfony\Component\Console\Formatter\OutputFormatterInterface;
  12. /**
  13. * ConsoleOutput is the default class for all CLI output. It uses STDOUT and STDERR.
  14. *
  15. * This class is a convenient wrapper around `StreamOutput` for both STDOUT and STDERR.
  16. *
  17. * $output = new ConsoleOutput();
  18. *
  19. * This is equivalent to:
  20. *
  21. * $output = new StreamOutput(fopen('php://stdout', 'w'));
  22. * $stdErr = new StreamOutput(fopen('php://stderr', 'w'));
  23. *
  24. * @author Fabien Potencier <fabien@symfony.com>
  25. */
  26. class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface
  27. {
  28. private OutputInterface $stderr;
  29. private array $consoleSectionOutputs = [];
  30. /**
  31. * @param int $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
  32. * @param bool|null $decorated Whether to decorate messages (null for auto-guessing)
  33. * @param OutputFormatterInterface|null $formatter Output formatter instance (null to use default OutputFormatter)
  34. */
  35. public function __construct(int $verbosity = self::VERBOSITY_NORMAL, ?bool $decorated = null, ?OutputFormatterInterface $formatter = null)
  36. {
  37. parent::__construct($this->openOutputStream(), $verbosity, $decorated, $formatter);
  38. if (null === $formatter) {
  39. // for BC reasons, stdErr has it own Formatter only when user don't inject a specific formatter.
  40. $this->stderr = new StreamOutput($this->openErrorStream(), $verbosity, $decorated);
  41. return;
  42. }
  43. $actualDecorated = $this->isDecorated();
  44. $this->stderr = new StreamOutput($this->openErrorStream(), $verbosity, $decorated, $this->getFormatter());
  45. if (null === $decorated) {
  46. $this->setDecorated($actualDecorated && $this->stderr->isDecorated());
  47. }
  48. }
  49. /**
  50. * Creates a new output section.
  51. */
  52. public function section(): ConsoleSectionOutput
  53. {
  54. return new ConsoleSectionOutput($this->getStream(), $this->consoleSectionOutputs, $this->getVerbosity(), $this->isDecorated(), $this->getFormatter());
  55. }
  56. /**
  57. * @return void
  58. */
  59. public function setDecorated(bool $decorated)
  60. {
  61. parent::setDecorated($decorated);
  62. $this->stderr->setDecorated($decorated);
  63. }
  64. /**
  65. * @return void
  66. */
  67. public function setFormatter(OutputFormatterInterface $formatter)
  68. {
  69. parent::setFormatter($formatter);
  70. $this->stderr->setFormatter($formatter);
  71. }
  72. /**
  73. * @return void
  74. */
  75. public function setVerbosity(int $level)
  76. {
  77. parent::setVerbosity($level);
  78. $this->stderr->setVerbosity($level);
  79. }
  80. public function getErrorOutput(): OutputInterface
  81. {
  82. return $this->stderr;
  83. }
  84. /**
  85. * @return void
  86. */
  87. public function setErrorOutput(OutputInterface $error)
  88. {
  89. $this->stderr = $error;
  90. }
  91. /**
  92. * Returns true if current environment supports writing console output to
  93. * STDOUT.
  94. */
  95. protected function hasStdoutSupport(): bool
  96. {
  97. return false === $this->isRunningOS400();
  98. }
  99. /**
  100. * Returns true if current environment supports writing console output to
  101. * STDERR.
  102. */
  103. protected function hasStderrSupport(): bool
  104. {
  105. return false === $this->isRunningOS400();
  106. }
  107. /**
  108. * Checks if current executing environment is IBM iSeries (OS400), which
  109. * doesn't properly convert character-encodings between ASCII to EBCDIC.
  110. */
  111. private function isRunningOS400(): bool
  112. {
  113. $checks = [
  114. \function_exists('php_uname') ? php_uname('s') : '',
  115. getenv('OSTYPE'),
  116. \PHP_OS,
  117. ];
  118. return false !== stripos(implode(';', $checks), 'OS400');
  119. }
  120. /**
  121. * @return resource
  122. */
  123. private function openOutputStream()
  124. {
  125. if (!$this->hasStdoutSupport()) {
  126. return fopen('php://output', 'w');
  127. }
  128. // Use STDOUT when possible to prevent from opening too many file descriptors
  129. return \defined('STDOUT') ? \STDOUT : (@fopen('php://stdout', 'w') ?: fopen('php://output', 'w'));
  130. }
  131. /**
  132. * @return resource
  133. */
  134. private function openErrorStream()
  135. {
  136. if (!$this->hasStderrSupport()) {
  137. return fopen('php://output', 'w');
  138. }
  139. // Use STDERR when possible to prevent from opening too many file descriptors
  140. return \defined('STDERR') ? \STDERR : (@fopen('php://stderr', 'w') ?: fopen('php://output', 'w'));
  141. }
  142. }