vendor/symfony/var-dumper/Dumper/CliDumper.php line 67

Open in your IDE?
  1. <?php
  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.  */
  12. namespace Symfony\Component\VarDumper\Dumper;
  14. use Symfony\Component\VarDumper\Cloner\Cursor;
  15. use Symfony\Component\VarDumper\Cloner\Stub;
  17. /**
  18.  * CliDumper dumps variables for command line output.
  19.  *
  20.  * @author Nicolas Grekas <p@tchwork.com>
  21.  */
  22. class CliDumper extends AbstractDumper
  23. {
  24.     public static $defaultColors;
  25.     public static $defaultOutput = 'php://stdout';
  27.     protected $colors;
  28.     protected $maxStringWidth = 0;
  29.     protected $styles = [
  30.         // See http://en.wikipedia.org/wiki/ANSI_escape_code#graphics
  31.         'default' => '0;38;5;208',
  32.         'num' => '1;38;5;38',
  33.         'const' => '1;38;5;208',
  34.         'str' => '1;38;5;113',
  35.         'note' => '38;5;38',
  36.         'ref' => '38;5;247',
  37.         'public' => '',
  38.         'protected' => '',
  39.         'private' => '',
  40.         'meta' => '38;5;170',
  41.         'key' => '38;5;113',
  42.         'index' => '38;5;38',
  43.     ];
  45.     protected static $controlCharsRx = '/[\x00-\x1F\x7F]+/';
  46.     protected static $controlCharsMap = [
  47.         "\t" => '\t',
  48.         "\n" => '\n',
  49.         "\v" => '\v',
  50.         "\f" => '\f',
  51.         "\r" => '\r',
  52.         "\033" => '\e',
  53.     ];
  55.     protected $collapseNextHash = false;
  56.     protected $expandNextHash = false;
  58.     private $displayOptions = [
  59.         'fileLinkFormat' => null,
  60.     ];
  62.     private $handlesHrefGracefully;
  64.     /**
  65.      * {@inheritdoc}
  66.      */
  67.     public function __construct($output = null, string $charset = null, int $flags = 0)
  68.     {
  69.         parent::__construct($output, $charset, $flags);
  71.         if ('\\' === \DIRECTORY_SEPARATOR && !$this->isWindowsTrueColor()) {
  72.             // Use only the base 16 xterm colors when using ANSICON or standard Windows 10 CLI
  73.             $this->setStyles([
  74.                 'default' => '31',
  75.                 'num' => '1;34',
  76.                 'const' => '1;31',
  77.                 'str' => '1;32',
  78.                 'note' => '34',
  79.                 'ref' => '1;30',
  80.                 'meta' => '35',
  81.                 'key' => '32',
  82.                 'index' => '34',
  83.             ]);
  84.         }
  86.         $this->displayOptions['fileLinkFormat'] = \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format') ?: 'file://%f#L%l';
  87.     }
  89.     /**
  90.      * Enables/disables colored output.
  91.      */
  92.     public function setColors(bool $colors)
  93.     {
  94.         $this->colors = $colors;
  95.     }
  97.     /**
  98.      * Sets the maximum number of characters per line for dumped strings.
  99.      */
  100.     public function setMaxStringWidth(int $maxStringWidth)
  101.     {
  102.         $this->maxStringWidth = $maxStringWidth;
  103.     }
  105.     /**
  106.      * Configures styles.
  107.      *
  108.      * @param array $styles A map of style names to style definitions
  109.      */
  110.     public function setStyles(array $styles)
  111.     {
  112.         $this->styles = $styles + $this->styles;
  113.     }
  115.     /**
  116.      * Configures display options.
  117.      *
  118.      * @param array $displayOptions A map of display options to customize the behavior
  119.      */
  120.     public function setDisplayOptions(array $displayOptions)
  121.     {
  122.         $this->displayOptions = $displayOptions + $this->displayOptions;
  123.     }
  125.     /**
  126.      * {@inheritdoc}
  127.      */
  128.     public function dumpScalar(Cursor $cursor, string $type, $value)
  129.     {
  130.         $this->dumpKey($cursor);
  131.         $this->collapseNextHash = $this->expandNextHash = false;
  133.         $style = 'const';
  134.         $attr = $cursor->attr;
  136.         switch ($type) {
  137.             case 'default':
  138.                 $style = 'default';
  139.                 break;
  141.             case 'integer':
  142.                 $style = 'num';
  144.                 if (isset($this->styles['integer'])) {
  145.                     $style = 'integer';
  146.                 }
  148.                 break;
  150.             case 'double':
  151.                 $style = 'num';
  153.                 if (isset($this->styles['float'])) {
  154.                     $style = 'float';
  155.                 }
  157.                 switch (true) {
  158.                     case \INF === $value:  $value = 'INF'; break;
  159.                     case -\INF === $value: $value = '-INF'; break;
  160.                     case is_nan($value):  $value = 'NAN'; break;
  161.                     default:
  162.                         $value = (string) $value;
  163.                         if (!str_contains($value, $this->decimalPoint)) {
  164.                             $value .= $this->decimalPoint.'0';
  165.                         }
  166.                         break;
  167.                 }
  168.                 break;
  170.             case 'NULL':
  171.                 $value = 'null';
  172.                 break;
  174.             case 'boolean':
  175.                 $value = $value ? 'true' : 'false';
  176.                 break;
  178.             default:
  179.                 $attr += ['value' => $this->utf8Encode($value)];
  180.                 $value = $this->utf8Encode($type);
  181.                 break;
  182.         }
  184.         $this->line .= $this->style($style, $value, $attr);
  186.         $this->endValue($cursor);
  187.     }
  189.     /**
  190.      * {@inheritdoc}
  191.      */
  192.     public function dumpString(Cursor $cursor, string $str, bool $bin, int $cut)
  193.     {
  194.         $this->dumpKey($cursor);
  195.         $this->collapseNextHash = $this->expandNextHash = false;
  196.         $attr = $cursor->attr;
  198.         if ($bin) {
  199.             $str = $this->utf8Encode($str);
  200.         }
  201.         if ('' === $str) {
  202.             $this->line .= '""';
  203.             if ($cut) {
  204.                 $this->line .= '…'.$cut;
  205.             }
  206.             $this->endValue($cursor);
  207.         } else {
  208.             $attr += [
  209.                 'length' => 0 <= $cut ? mb_strlen($str, 'UTF-8') + $cut : 0,
  210.                 'binary' => $bin,
  211.             ];
  212.             $str = $bin && false !== strpos($str, "\0") ? [$str] : explode("\n", $str);
  213.             if (isset($str[1]) && !isset($str[2]) && !isset($str[1][0])) {
  214.                 unset($str[1]);
  215.                 $str[0] .= "\n";
  216.             }
  217.             $m = \count($str) - 1;
  218.             $i = $lineCut = 0;
  220.             if (self::DUMP_STRING_LENGTH & $this->flags) {
  221.                 $this->line .= '('.$attr['length'].') ';
  222.             }
  223.             if ($bin) {
  224.                 $this->line .= 'b';
  225.             }
  227.             if ($m) {
  228.                 $this->line .= '"""';
  229.                 $this->dumpLine($cursor->depth);
  230.             } else {
  231.                 $this->line .= '"';
  232.             }
  234.             foreach ($str as $str) {
  235.                 if ($i < $m) {
  236.                     $str .= "\n";
  237.                 }
  238.                 if (0 < $this->maxStringWidth && $this->maxStringWidth < $len = mb_strlen($str, 'UTF-8')) {
  239.                     $str = mb_substr($str, 0, $this->maxStringWidth, 'UTF-8');
  240.                     $lineCut = $len - $this->maxStringWidth;
  241.                 }
  242.                 if ($m && 0 < $cursor->depth) {
  243.                     $this->line .= $this->indentPad;
  244.                 }
  245.                 if ('' !== $str) {
  246.                     $this->line .= $this->style('str', $str, $attr);
  247.                 }
  248.                 if ($i++ == $m) {
  249.                     if ($m) {
  250.                         if ('' !== $str) {
  251.                             $this->dumpLine($cursor->depth);
  252.                             if (0 < $cursor->depth) {
  253.                                 $this->line .= $this->indentPad;
  254.                             }
  255.                         }
  256.                         $this->line .= '"""';
  257.                     } else {
  258.                         $this->line .= '"';
  259.                     }
  260.                     if ($cut < 0) {
  261.                         $this->line .= '…';
  262.                         $lineCut = 0;
  263.                     } elseif ($cut) {
  264.                         $lineCut += $cut;
  265.                     }
  266.                 }
  267.                 if ($lineCut) {
  268.                     $this->line .= '…'.$lineCut;
  269.                     $lineCut = 0;
  270.                 }
  272.                 if ($i > $m) {
  273.                     $this->endValue($cursor);
  274.                 } else {
  275.                     $this->dumpLine($cursor->depth);
  276.                 }
  277.             }
  278.         }
  279.     }
  281.     /**
  282.      * {@inheritdoc}
  283.      */
  284.     public function enterHash(Cursor $cursor, int $type, $class, bool $hasChild)
  285.     {
  286.         if (null === $this->colors) {
  287.             $this->colors = $this->supportsColors();
  288.         }
  290.         $this->dumpKey($cursor);
  291.         $this->expandNextHash = false;
  292.         $attr = $cursor->attr;
  294.         if ($this->collapseNextHash) {
  295.             $cursor->skipChildren = true;
  296.             $this->collapseNextHash = $hasChild = false;
  297.         }
  299.         $class = $this->utf8Encode($class);
  300.         if (Cursor::HASH_OBJECT === $type) {
  301.             $prefix = $class && 'stdClass' !== $class ? $this->style('note', $class, $attr).(empty($attr['cut_hash']) ? ' {' : '') : '{';
  302.         } elseif (Cursor::HASH_RESOURCE === $type) {
  303.             $prefix = $this->style('note', $class.' resource', $attr).($hasChild ? ' {' : ' ');
  304.         } else {
  305.             $prefix = $class && !(self::DUMP_LIGHT_ARRAY & $this->flags) ? $this->style('note', 'array:'.$class).' [' : '[';
  306.         }
  308.         if (($cursor->softRefCount || 0 < $cursor->softRefHandle) && empty($attr['cut_hash'])) {
  309.             $prefix .= $this->style('ref', (Cursor::HASH_RESOURCE === $type ? '@' : '#').(0 < $cursor->softRefHandle ? $cursor->softRefHandle : $cursor->softRefTo), ['count' => $cursor->softRefCount]);
  310.         } elseif ($cursor->hardRefTo && !$cursor->refIndex && $class) {
  311.             $prefix .= $this->style('ref', '&'.$cursor->hardRefTo, ['count' => $cursor->hardRefCount]);
  312.         } elseif (!$hasChild && Cursor::HASH_RESOURCE === $type) {
  313.             $prefix = substr($prefix, 0, -1);
  314.         }
  316.         $this->line .= $prefix;
  318.         if ($hasChild) {
  319.             $this->dumpLine($cursor->depth);
  320.         }
  321.     }
  323.     /**
  324.      * {@inheritdoc}
  325.      */
  326.     public function leaveHash(Cursor $cursor, int $type, $class, bool $hasChild, int $cut)
  327.     {
  328.         if (empty($cursor->attr['cut_hash'])) {
  329.             $this->dumpEllipsis($cursor, $hasChild, $cut);
  330.             $this->line .= Cursor::HASH_OBJECT === $type ? '}' : (Cursor::HASH_RESOURCE !== $type ? ']' : ($hasChild ? '}' : ''));
  331.         }
  333.         $this->endValue($cursor);
  334.     }
  336.     /**
  337.      * Dumps an ellipsis for cut children.
  338.      *
  339.      * @param bool $hasChild When the dump of the hash has child item
  340.      * @param int  $cut      The number of items the hash has been cut by
  341.      */
  342.     protected function dumpEllipsis(Cursor $cursor, bool $hasChild, int $cut)
  343.     {
  344.         if ($cut) {
  345.             $this->line .= ' …';
  346.             if (0 < $cut) {
  347.                 $this->line .= $cut;
  348.             }
  349.             if ($hasChild) {
  350.                 $this->dumpLine($cursor->depth + 1);
  351.             }
  352.         }
  353.     }
  355.     /**
  356.      * Dumps a key in a hash structure.
  357.      */
  358.     protected function dumpKey(Cursor $cursor)
  359.     {
  360.         if (null !== $key = $cursor->hashKey) {
  361.             if ($cursor->hashKeyIsBinary) {
  362.                 $key = $this->utf8Encode($key);
  363.             }
  364.             $attr = ['binary' => $cursor->hashKeyIsBinary];
  365.             $bin = $cursor->hashKeyIsBinary ? 'b' : '';
  366.             $style = 'key';
  367.             switch ($cursor->hashType) {
  368.                 default:
  369.                 case Cursor::HASH_INDEXED:
  370.                     if (self::DUMP_LIGHT_ARRAY & $this->flags) {
  371.                         break;
  372.                     }
  373.                     $style = 'index';
  374.                     // no break
  375.                 case Cursor::HASH_ASSOC:
  376.                     if (\is_int($key)) {
  377.                         $this->line .= $this->style($style, $key).' => ';
  378.                     } else {
  379.                         $this->line .= $bin.'"'.$this->style($style, $key).'" => ';
  380.                     }
  381.                     break;
  383.                 case Cursor::HASH_RESOURCE:
  384.                     $key = "\0~\0".$key;
  385.                     // no break
  386.                 case Cursor::HASH_OBJECT:
  387.                     if (!isset($key[0]) || "\0" !== $key[0]) {
  388.                         $this->line .= '+'.$bin.$this->style('public', $key).': ';
  389.                     } elseif (0 < strpos($key, "\0", 1)) {
  390.                         $key = explode("\0", substr($key, 1), 2);
  392.                         switch ($key[0][0]) {
  393.                             case '+': // User inserted keys
  394.                                 $attr['dynamic'] = true;
  395.                                 $this->line .= '+'.$bin.'"'.$this->style('public', $key[1], $attr).'": ';
  396.                                 break 2;
  397.                             case '~':
  398.                                 $style = 'meta';
  399.                                 if (isset($key[0][1])) {
  400.                                     parse_str(substr($key[0], 1), $attr);
  401.                                     $attr += ['binary' => $cursor->hashKeyIsBinary];
  402.                                 }
  403.                                 break;
  404.                             case '*':
  405.                                 $style = 'protected';
  406.                                 $bin = '#'.$bin;
  407.                                 break;
  408.                             default:
  409.                                 $attr['class'] = $key[0];
  410.                                 $style = 'private';
  411.                                 $bin = '-'.$bin;
  412.                                 break;
  413.                         }
  415.                         if (isset($attr['collapse'])) {
  416.                             if ($attr['collapse']) {
  417.                                 $this->collapseNextHash = true;
  418.                             } else {
  419.                                 $this->expandNextHash = true;
  420.                             }
  421.                         }
  423.                         $this->line .= $bin.$this->style($style, $key[1], $attr).($attr['separator'] ?? ': ');
  424.                     } else {
  425.                         // This case should not happen
  426.                         $this->line .= '-'.$bin.'"'.$this->style('private', $key, ['class' => '']).'": ';
  427.                     }
  428.                     break;
  429.             }
  431.             if ($cursor->hardRefTo) {
  432.                 $this->line .= $this->style('ref', '&'.($cursor->hardRefCount ? $cursor->hardRefTo : ''), ['count' => $cursor->hardRefCount]).' ';
  433.             }
  434.         }
  435.     }
  437.     /**
  438.      * Decorates a value with some style.
  439.      *
  440.      * @param string $style The type of style being applied
  441.      * @param string $value The value being styled
  442.      * @param array  $attr  Optional context information
  443.      *
  444.      * @return string
  445.      */
  446.     protected function style(string $style, string $value, array $attr = [])
  447.     {
  448.         if (null === $this->colors) {
  449.             $this->colors = $this->supportsColors();
  450.         }
  452.         if (null === $this->handlesHrefGracefully) {
  453.             $this->handlesHrefGracefully = 'JetBrains-JediTerm' !== getenv('TERMINAL_EMULATOR')
  454.                 && (!getenv('KONSOLE_VERSION') || (int) getenv('KONSOLE_VERSION') > 201100)
  455.                 && !isset($_SERVER['IDEA_INITIAL_DIRECTORY']);
  456.         }
  458.         if (isset($attr['ellipsis'], $attr['ellipsis-type'])) {
  459.             $prefix = substr($value, 0, -$attr['ellipsis']);
  460.             if ('cli' === \PHP_SAPI && 'path' === $attr['ellipsis-type'] && isset($_SERVER[$pwd = '\\' === \DIRECTORY_SEPARATOR ? 'CD' : 'PWD']) && str_starts_with($prefix, $_SERVER[$pwd])) {
  461.                 $prefix = '.'.substr($prefix, \strlen($_SERVER[$pwd]));
  462.             }
  463.             if (!empty($attr['ellipsis-tail'])) {
  464.                 $prefix .= substr($value, -$attr['ellipsis'], $attr['ellipsis-tail']);
  465.                 $value = substr($value, -$attr['ellipsis'] + $attr['ellipsis-tail']);
  466.             } else {
  467.                 $value = substr($value, -$attr['ellipsis']);
  468.             }
  470.             $value = $this->style('default', $prefix).$this->style($style, $value);
  472.             goto href;
  473.         }
  475.         $map = static::$controlCharsMap;
  476.         $startCchr = $this->colors ? "\033[m\033[{$this->styles['default']}m" : '';
  477.         $endCchr = $this->colors ? "\033[m\033[{$this->styles[$style]}m" : '';
  478.         $value = preg_replace_callback(static::$controlCharsRx, function ($c) use ($map, $startCchr, $endCchr) {
  479.             $s = $startCchr;
  480.             $c = $c[$i = 0];
  481.             do {
  482.                 $s .= $map[$c[$i]] ?? sprintf('\x%02X', \ord($c[$i]));
  483.             } while (isset($c[++$i]));
  485.             return $s.$endCchr;
  486.         }, $value, -1, $cchrCount);
  488.         if ($this->colors) {
  489.             if ($cchrCount && "\033" === $value[0]) {
  490.                 $value = substr($value, \strlen($startCchr));
  491.             } else {
  492.                 $value = "\033[{$this->styles[$style]}m".$value;
  493.             }
  494.             if ($cchrCount && str_ends_with($value, $endCchr)) {
  495.                 $value = substr($value, 0, -\strlen($endCchr));
  496.             } else {
  497.                 $value .= "\033[{$this->styles['default']}m";
  498.             }
  499.         }
  501.         href:
  502.         if ($this->colors && $this->handlesHrefGracefully) {
  503.             if (isset($attr['file']) && $href = $this->getSourceLink($attr['file'], $attr['line'] ?? 0)) {
  504.                 if ('note' === $style) {
  505.                     $value .= "\033]8;;{$href}\033\\^\033]8;;\033\\";
  506.                 } else {
  507.                     $attr['href'] = $href;
  508.                 }
  509.             }
  510.             if (isset($attr['href'])) {
  511.                 $value = "\033]8;;{$attr['href']}\033\\{$value}\033]8;;\033\\";
  512.             }
  513.         } elseif ($attr['if_links'] ?? false) {
  514.             return '';
  515.         }
  517.         return $value;
  518.     }
  520.     /**
  521.      * @return bool
  522.      */
  523.     protected function supportsColors()
  524.     {
  525.         if ($this->outputStream !== static::$defaultOutput) {
  526.             return $this->hasColorSupport($this->outputStream);
  527.         }
  528.         if (null !== static::$defaultColors) {
  529.             return static::$defaultColors;
  530.         }
  531.         if (isset($_SERVER['argv'][1])) {
  532.             $colors = $_SERVER['argv'];
  533.             $i = \count($colors);
  534.             while (--$i > 0) {
  535.                 if (isset($colors[$i][5])) {
  536.                     switch ($colors[$i]) {
  537.                         case '--ansi':
  538.                         case '--color':
  539.                         case '--color=yes':
  540.                         case '--color=force':
  541.                         case '--color=always':
  542.                         case '--colors=always':
  543.                             return static::$defaultColors = true;
  545.                         case '--no-ansi':
  546.                         case '--color=no':
  547.                         case '--color=none':
  548.                         case '--color=never':
  549.                         case '--colors=never':
  550.                             return static::$defaultColors = false;
  551.                     }
  552.                 }
  553.             }
  554.         }
  556.         $h = stream_get_meta_data($this->outputStream) + ['wrapper_type' => null];
  557.         $h = 'Output' === $h['stream_type'] && 'PHP' === $h['wrapper_type'] ? fopen('php://stdout', 'w') : $this->outputStream;
  559.         return static::$defaultColors = $this->hasColorSupport($h);
  560.     }
  562.     /**
  563.      * {@inheritdoc}
  564.      */
  565.     protected function dumpLine(int $depth, bool $endOfValue = false)
  566.     {
  567.         if ($this->colors) {
  568.             $this->line = sprintf("\033[%sm%s\033[m", $this->styles['default'], $this->line);
  569.         }
  570.         parent::dumpLine($depth);
  571.     }
  573.     protected function endValue(Cursor $cursor)
  574.     {
  575.         if (-1 === $cursor->hashType) {
  576.             return;
  577.         }
  579.         if (Stub::ARRAY_INDEXED === $cursor->hashType || Stub::ARRAY_ASSOC === $cursor->hashType) {
  580.             if (self::DUMP_TRAILING_COMMA & $this->flags && 0 < $cursor->depth) {
  581.                 $this->line .= ',';
  582.             } elseif (self::DUMP_COMMA_SEPARATOR & $this->flags && 1 < $cursor->hashLength - $cursor->hashIndex) {
  583.                 $this->line .= ',';
  584.             }
  585.         }
  587.         $this->dumpLine($cursor->depth, true);
  588.     }
  590.     /**
  591.      * Returns true if the stream supports colorization.
  592.      *
  593.      * Reference: Composer\XdebugHandler\Process::supportsColor
  594.      * https://github.com/composer/xdebug-handler
  595.      *
  596.      * @param mixed $stream A CLI output stream
  597.      */
  598.     private function hasColorSupport($stream): bool
  599.     {
  600.         if (!\is_resource($stream) || 'stream' !== get_resource_type($stream)) {
  601.             return false;
  602.         }
  604.         // Follow https://no-color.org/
  605.         if (isset($_SERVER['NO_COLOR']) || false !== getenv('NO_COLOR')) {
  606.             return false;
  607.         }
  609.         if ('Hyper' === getenv('TERM_PROGRAM')) {
  610.             return true;
  611.         }
  613.         if (\DIRECTORY_SEPARATOR === '\\') {
  614.             return (\function_exists('sapi_windows_vt100_support')
  615.                 && @sapi_windows_vt100_support($stream))
  616.                 || false !== getenv('ANSICON')
  617.                 || 'ON' === getenv('ConEmuANSI')
  618.                 || 'xterm' === getenv('TERM');
  619.         }
  621.         return stream_isatty($stream);
  622.     }
  624.     /**
  625.      * Returns true if the Windows terminal supports true color.
  626.      *
  627.      * Note that this does not check an output stream, but relies on environment
  628.      * variables from known implementations, or a PHP and Windows version that
  629.      * supports true color.
  630.      */
  631.     private function isWindowsTrueColor(): bool
  632.     {
  633.         $result = 183 <= getenv('ANSICON_VER')
  634.             || 'ON' === getenv('ConEmuANSI')
  635.             || 'xterm' === getenv('TERM')
  636.             || 'Hyper' === getenv('TERM_PROGRAM');
  638.         if (!$result) {
  639.             $version = sprintf(
  640.                 '%s.%s.%s',
  641.                 PHP_WINDOWS_VERSION_MAJOR,
  642.                 PHP_WINDOWS_VERSION_MINOR,
  643.                 PHP_WINDOWS_VERSION_BUILD
  644.             );
  645.             $result = $version >= '10.0.15063';
  646.         }
  648.         return $result;
  649.     }
  651.     private function getSourceLink(string $file, int $line)
  652.     {
  653.         if ($fmt = $this->displayOptions['fileLinkFormat']) {
  654.             return \is_string($fmt) ? strtr($fmt, ['%f' => $file, '%l' => $line]) : ($fmt->format($file, $line) ?: 'file://'.$file.'#L'.$line);
  655.         }
  657.         return false;
  658.     }
  659. }