CliDumper.php 21 KB

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