www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/console/Style/SymfonyStyle.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\Console\Style;
  13
  14 use Symfony\Component\Console\Exception\RuntimeException;
  15 use Symfony\Component\Console\Formatter\OutputFormatter;
  16 use Symfony\Component\Console\Helper\Helper;
  17 use Symfony\Component\Console\Helper\ProgressBar;
  18 use Symfony\Component\Console\Helper\SymfonyQuestionHelper;
  19 use Symfony\Component\Console\Helper\Table;
  20 use Symfony\Component\Console\Input\InputInterface;
  21 use Symfony\Component\Console\Output\BufferedOutput;
  22 use Symfony\Component\Console\Output\OutputInterface;
  23 use Symfony\Component\Console\Question\ChoiceQuestion;
  24 use Symfony\Component\Console\Question\ConfirmationQuestion;
  25 use Symfony\Component\Console\Question\Question;
  26 use Symfony\Component\Console\Terminal;
  27
  28 /**
  29  * Output decorator helpers for the Symfony Style Guide.
  30  *
  31  * @author Kevin Bond <kevinbond@gmail.com>
  32  */
  33 class SymfonyStyle extends OutputStyle
  34 {
  35     const MAX_LINE_LENGTH = 120;
  36
  37     private $input;
  38     private $questionHelper;
  39     private $progressBar;
  40     private $lineLength;
  41     private $bufferedOutput;
  42
  43     public function __construct(InputInterface $input, OutputInterface $output)
  44     {
  45         $this->input = $input;
  46         $this->bufferedOutput = new BufferedOutput($output->getVerbosity(), false, clone $output->getFormatter());
  47         // Windows cmd wraps lines as soon as the terminal width is reached, whether there are following chars or not.
  48         $width = (new Terminal())->getWidth() ?: self::MAX_LINE_LENGTH;
  49         $this->lineLength = min($width - (int) (\DIRECTORY_SEPARATOR === '\\'), self::MAX_LINE_LENGTH);
  50
  51         parent::__construct($output);
  52     }
  53
  54     /**
  55      * Formats a message as a block of text.
  56      *
  57      * @param string|array $messages The message to write in the block
  58      * @param string|null  $type     The block type (added in [] on first line)
  59      * @param string|null  $style    The style to apply to the whole block
  60      * @param string       $prefix   The prefix for the block
  61      * @param bool         $padding  Whether to add vertical padding
  62      * @param bool         $escape   Whether to escape the message
  63      */
  64     public function block($messages, $type = null, $style = null, $prefix = ' ', $padding = false, $escape = true)
  65     {
  66         $messages = \is_array($messages) ? array_values($messages) : array($messages);
  67
  68         $this->autoPrependBlock();
  69         $this->writeln($this->createBlock($messages, $type, $style, $prefix, $padding, $escape));
  70         $this->newLine();
  71     }
  72
  73     /**
  74      * {@inheritdoc}
  75      */
  76     public function title($message)
  77     {
  78         $this->autoPrependBlock();
  79         $this->writeln(array(
  80             sprintf('<comment>%s</>', OutputFormatter::escapeTrailingBackslash($message)),
  81             sprintf('<comment>%s</>', str_repeat('=', Helper::strlenWithoutDecoration($this->getFormatter(), $message))),
  82         ));
  83         $this->newLine();
  84     }
  85
  86     /**
  87      * {@inheritdoc}
  88      */
  89     public function section($message)
  90     {
  91         $this->autoPrependBlock();
  92         $this->writeln(array(
  93             sprintf('<comment>%s</>', OutputFormatter::escapeTrailingBackslash($message)),
  94             sprintf('<comment>%s</>', str_repeat('-', Helper::strlenWithoutDecoration($this->getFormatter(), $message))),
  95         ));
  96         $this->newLine();
  97     }
  98
  99     /**
 100      * {@inheritdoc}
 101      */
 102     public function listing(array $elements)
 103     {
 104         $this->autoPrependText();
 105         $elements = array_map(function ($element) {
 106             return sprintf(' * %s', $element);
 107         }, $elements);
 108
 109         $this->writeln($elements);
 110         $this->newLine();
 111     }
 112
 113     /**
 114      * {@inheritdoc}
 115      */
 116     public function text($message)
 117     {
 118         $this->autoPrependText();
 119
 120         $messages = \is_array($message) ? array_values($message) : array($message);
 121         foreach ($messages as $message) {
 122             $this->writeln(sprintf(' %s', $message));
 123         }
 124     }
 125
 126     /**
 127      * Formats a command comment.
 128      *
 129      * @param string|array $message
 130      */
 131     public function comment($message)
 132     {
 133         $this->block($message, null, null, '<fg=default;bg=default> // </>', false, false);
 134     }
 135
 136     /**
 137      * {@inheritdoc}
 138      */
 139     public function success($message)
 140     {
 141         $this->block($message, 'OK', 'fg=black;bg=green', ' ', true);
 142     }
 143
 144     /**
 145      * {@inheritdoc}
 146      */
 147     public function error($message)
 148     {
 149         $this->block($message, 'ERROR', 'fg=white;bg=red', ' ', true);
 150     }
 151
 152     /**
 153      * {@inheritdoc}
 154      */
 155     public function warning($message)
 156     {
 157         $this->block($message, 'WARNING', 'fg=white;bg=red', ' ', true);
 158     }
 159
 160     /**
 161      * {@inheritdoc}
 162      */
 163     public function note($message)
 164     {
 165         $this->block($message, 'NOTE', 'fg=yellow', ' ! ');
 166     }
 167
 168     /**
 169      * {@inheritdoc}
 170      */
 171     public function caution($message)
 172     {
 173         $this->block($message, 'CAUTION', 'fg=white;bg=red', ' ! ', true);
 174     }
 175
 176     /**
 177      * {@inheritdoc}
 178      */
 179     public function table(array $headers, array $rows)
 180     {
 181         $style = clone Table::getStyleDefinition('symfony-style-guide');
 182         $style->setCellHeaderFormat('<info>%s</info>');
 183
 184         $table = new Table($this);
 185         $table->setHeaders($headers);
 186         $table->setRows($rows);
 187         $table->setStyle($style);
 188
 189         $table->render();
 190         $this->newLine();
 191     }
 192
 193     /**
 194      * {@inheritdoc}
 195      */
 196     public function ask($question, $default = null, $validator = null)
 197     {
 198         $question = new Question($question, $default);
 199         $question->setValidator($validator);
 200
 201         return $this->askQuestion($question);
 202     }
 203
 204     /**
 205      * {@inheritdoc}
 206      */
 207     public function askHidden($question, $validator = null)
 208     {
 209         $question = new Question($question);
 210
 211         $question->setHidden(true);
 212         $question->setValidator($validator);
 213
 214         return $this->askQuestion($question);
 215     }
 216
 217     /**
 218      * {@inheritdoc}
 219      */
 220     public function confirm($question, $default = true)
 221     {
 222         return $this->askQuestion(new ConfirmationQuestion($question, $default));
 223     }
 224
 225     /**
 226      * {@inheritdoc}
 227      */
 228     public function choice($question, array $choices, $default = null)
 229     {
 230         if (null !== $default) {
 231             $values = array_flip($choices);
 232             $default = $values[$default];
 233         }
 234
 235         return $this->askQuestion(new ChoiceQuestion($question, $choices, $default));
 236     }
 237
 238     /**
 239      * {@inheritdoc}
 240      */
 241     public function progressStart($max = 0)
 242     {
 243         $this->progressBar = $this->createProgressBar($max);
 244         $this->progressBar->start();
 245     }
 246
 247     /**
 248      * {@inheritdoc}
 249      */
 250     public function progressAdvance($step = 1)
 251     {
 252         $this->getProgressBar()->advance($step);
 253     }
 254
 255     /**
 256      * {@inheritdoc}
 257      */
 258     public function progressFinish()
 259     {
 260         $this->getProgressBar()->finish();
 261         $this->newLine(2);
 262         $this->progressBar = null;
 263     }
 264
 265     /**
 266      * {@inheritdoc}
 267      */
 268     public function createProgressBar($max = 0)
 269     {
 270         $progressBar = parent::createProgressBar($max);
 271
 272         if ('\\' !== \DIRECTORY_SEPARATOR || 'Hyper' === getenv('TERM_PROGRAM')) {
 273             $progressBar->setEmptyBarCharacter('░'); // light shade character \u2591
 274             $progressBar->setProgressCharacter('');
 275             $progressBar->setBarCharacter('▓'); // dark shade character \u2593
 276         }
 277
 278         return $progressBar;
 279     }
 280
 281     /**
 282      * @return mixed
 283      */
 284     public function askQuestion(Question $question)
 285     {
 286         if ($this->input->isInteractive()) {
 287             $this->autoPrependBlock();
 288         }
 289
 290         if (!$this->questionHelper) {
 291             $this->questionHelper = new SymfonyQuestionHelper();
 292         }
 293
 294         $answer = $this->questionHelper->ask($this->input, $this, $question);
 295
 296         if ($this->input->isInteractive()) {
 297             $this->newLine();
 298             $this->bufferedOutput->write("\n");
 299         }
 300
 301         return $answer;
 302     }
 303
 304     /**
 305      * {@inheritdoc}
 306      */
 307     public function writeln($messages, $type = self::OUTPUT_NORMAL)
 308     {
 309         parent::writeln($messages, $type);
 310         $this->bufferedOutput->writeln($this->reduceBuffer($messages), $type);
 311     }
 312
 313     /**
 314      * {@inheritdoc}
 315      */
 316     public function write($messages, $newline = false, $type = self::OUTPUT_NORMAL)
 317     {
 318         parent::write($messages, $newline, $type);
 319         $this->bufferedOutput->write($this->reduceBuffer($messages), $newline, $type);
 320     }
 321
 322     /**
 323      * {@inheritdoc}
 324      */
 325     public function newLine($count = 1)
 326     {
 327         parent::newLine($count);
 328         $this->bufferedOutput->write(str_repeat("\n", $count));
 329     }
 330
 331     /**
 332      * Returns a new instance which makes use of stderr if available.
 333      *
 334      * @return self
 335      */
 336     public function getErrorStyle()
 337     {
 338         return new self($this->input, $this->getErrorOutput());
 339     }
 340
 341     /**
 342      * @return ProgressBar
 343      */
 344     private function getProgressBar()
 345     {
 346         if (!$this->progressBar) {
 347             throw new RuntimeException('The ProgressBar is not started.');
 348         }
 349
 350         return $this->progressBar;
 351     }
 352
 353     private function autoPrependBlock()
 354     {
 355         $chars = substr(str_replace(PHP_EOL, "\n", $this->bufferedOutput->fetch()), -2);
 356
 357         if (!isset($chars[0])) {
 358             return $this->newLine(); //empty history, so we should start with a new line.
 359         }
 360         //Prepend new line for each non LF chars (This means no blank line was output before)
 361         $this->newLine(2 - substr_count($chars, "\n"));
 362     }
 363
 364     private function autoPrependText()
 365     {
 366         $fetched = $this->bufferedOutput->fetch();
 367         //Prepend new line if last char isn't EOL:
 368         if ("\n" !== substr($fetched, -1)) {
 369             $this->newLine();
 370         }
 371     }
 372
 373     private function reduceBuffer($messages)
 374     {
 375         // We need to know if the two last chars are PHP_EOL
 376         // Preserve the last 4 chars inserted (PHP_EOL on windows is two chars) in the history buffer
 377         return array_map(function ($value) {
 378             return substr($value, -4);
 379         }, array_merge(array($this->bufferedOutput->fetch()), (array) $messages));
 380     }
 381
 382     private function createBlock($messages, $type = null, $style = null, $prefix = ' ', $padding = false, $escape = false)
 383     {
 384         $indentLength = 0;
 385         $prefixLength = Helper::strlenWithoutDecoration($this->getFormatter(), $prefix);
 386         $lines = array();
 387
 388         if (null !== $type) {
 389             $type = sprintf('[%s] ', $type);
 390             $indentLength = \strlen($type);
 391             $lineIndentation = str_repeat(' ', $indentLength);
 392         }
 393
 394         // wrap and add newlines for each element
 395         foreach ($messages as $key => $message) {
 396             if ($escape) {
 397                 $message = OutputFormatter::escape($message);
 398             }
 399
 400             $lines = array_merge($lines, explode(PHP_EOL, wordwrap($message, $this->lineLength - $prefixLength - $indentLength, PHP_EOL, true)));
 401
 402             if (\count($messages) > 1 && $key < \count($messages) - 1) {
 403                 $lines[] = '';
 404             }
 405         }
 406
 407         $firstLineIndex = 0;
 408         if ($padding && $this->isDecorated()) {
 409             $firstLineIndex = 1;
 410             array_unshift($lines, '');
 411             $lines[] = '';
 412         }
 413
 414         foreach ($lines as $i => &$line) {
 415             if (null !== $type) {
 416                 $line = $firstLineIndex === $i ? $type.$line : $lineIndentation.$line;
 417             }
 418
 419             $line = $prefix.$line;
 420             $line .= str_repeat(' ', $this->lineLength - Helper::strlenWithoutDecoration($this->getFormatter(), $line));
 421
 422             if ($style) {
 423                 $line = sprintf('<%s>%s</>', $style, $line);
 424             }
 425         }
 426
 427         return $lines;
 428     }
 429 }