Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\Console\Output;
Chris@0: 
Chris@0: use Symfony\Component\Console\Formatter\OutputFormatterInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * ConsoleOutput is the default class for all CLI output. It uses STDOUT and STDERR.
Chris@0:  *
Chris@0:  * This class is a convenient wrapper around `StreamOutput` for both STDOUT and STDERR.
Chris@0:  *
Chris@0:  *     $output = new ConsoleOutput();
Chris@0:  *
Chris@0:  * This is equivalent to:
Chris@0:  *
Chris@0:  *     $output = new StreamOutput(fopen('php://stdout', 'w'));
Chris@0:  *     $stdErr = new StreamOutput(fopen('php://stderr', 'w'));
Chris@0:  *
Chris@0:  * @author Fabien Potencier <fabien@symfony.com>
Chris@0:  */
Chris@0: class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface
Chris@0: {
Chris@0:     private $stderr;
Chris@0: 
Chris@0:     /**
Chris@0:      * @param int                           $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
Chris@0:      * @param bool|null                     $decorated Whether to decorate messages (null for auto-guessing)
Chris@0:      * @param OutputFormatterInterface|null $formatter Output formatter instance (null to use default OutputFormatter)
Chris@0:      */
Chris@0:     public function __construct($verbosity = self::VERBOSITY_NORMAL, $decorated = null, OutputFormatterInterface $formatter = null)
Chris@0:     {
Chris@0:         parent::__construct($this->openOutputStream(), $verbosity, $decorated, $formatter);
Chris@0: 
Chris@0:         $actualDecorated = $this->isDecorated();
Chris@0:         $this->stderr = new StreamOutput($this->openErrorStream(), $verbosity, $decorated, $this->getFormatter());
Chris@0: 
Chris@0:         if (null === $decorated) {
Chris@0:             $this->setDecorated($actualDecorated && $this->stderr->isDecorated());
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function setDecorated($decorated)
Chris@0:     {
Chris@0:         parent::setDecorated($decorated);
Chris@0:         $this->stderr->setDecorated($decorated);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function setFormatter(OutputFormatterInterface $formatter)
Chris@0:     {
Chris@0:         parent::setFormatter($formatter);
Chris@0:         $this->stderr->setFormatter($formatter);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function setVerbosity($level)
Chris@0:     {
Chris@0:         parent::setVerbosity($level);
Chris@0:         $this->stderr->setVerbosity($level);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getErrorOutput()
Chris@0:     {
Chris@0:         return $this->stderr;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function setErrorOutput(OutputInterface $error)
Chris@0:     {
Chris@0:         $this->stderr = $error;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns true if current environment supports writing console output to
Chris@0:      * STDOUT.
Chris@0:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     protected function hasStdoutSupport()
Chris@0:     {
Chris@0:         return false === $this->isRunningOS400();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns true if current environment supports writing console output to
Chris@0:      * STDERR.
Chris@0:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     protected function hasStderrSupport()
Chris@0:     {
Chris@0:         return false === $this->isRunningOS400();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Checks if current executing environment is IBM iSeries (OS400), which
Chris@0:      * doesn't properly convert character-encodings between ASCII to EBCDIC.
Chris@0:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     private function isRunningOS400()
Chris@0:     {
Chris@17:         $checks = [
Chris@17:             \function_exists('php_uname') ? php_uname('s') : '',
Chris@0:             getenv('OSTYPE'),
Chris@0:             PHP_OS,
Chris@17:         ];
Chris@0: 
Chris@0:         return false !== stripos(implode(';', $checks), 'OS400');
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @return resource
Chris@0:      */
Chris@0:     private function openOutputStream()
Chris@0:     {
Chris@0:         if (!$this->hasStdoutSupport()) {
Chris@0:             return fopen('php://output', 'w');
Chris@0:         }
Chris@0: 
Chris@0:         return @fopen('php://stdout', 'w') ?: fopen('php://output', 'w');
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @return resource
Chris@0:      */
Chris@0:     private function openErrorStream()
Chris@0:     {
Chris@0:         return fopen($this->hasStderrSupport() ? 'php://stderr' : 'php://output', 'w');
Chris@0:     }
Chris@0: }