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