1: <?php
2:
3: 4: 5: 6:
7:
8: namespace Tracy;
9:
10: use Tracy;
11:
12:
13: 14: 15:
16: class Dumper
17: {
18: const
19: DEPTH = 'depth',
20: TRUNCATE = 'truncate',
21: COLLAPSE = 'collapse',
22: COLLAPSE_COUNT = 'collapsecount',
23: LOCATION = 'location',
24: OBJECT_EXPORTERS = 'exporters',
25: LIVE = 'live';
26:
27: const
28: LOCATION_SOURCE = 0b0001,
29: LOCATION_LINK = 0b0010,
30: LOCATION_CLASS = 0b0100;
31:
32:
33: public static $terminalColors = [
34: 'bool' => '1;33',
35: 'null' => '1;33',
36: 'number' => '1;32',
37: 'string' => '1;36',
38: 'array' => '1;31',
39: 'key' => '1;37',
40: 'object' => '1;31',
41: 'visibility' => '1;30',
42: 'resource' => '1;37',
43: 'indent' => '1;30',
44: ];
45:
46:
47: public static $resources = [
48: 'stream' => 'stream_get_meta_data',
49: 'stream-context' => 'stream_context_get_options',
50: 'curl' => 'curl_getinfo',
51: ];
52:
53:
54: public static $objectExporters = [
55: 'Closure' => 'Tracy\Dumper::exportClosure',
56: 'SplFileInfo' => 'Tracy\Dumper::exportSplFileInfo',
57: 'SplObjectStorage' => 'Tracy\Dumper::exportSplObjectStorage',
58: '__PHP_Incomplete_Class' => 'Tracy\Dumper::exportPhpIncompleteClass',
59: ];
60:
61:
62: public static $livePrefix;
63:
64:
65: private static $liveStorage = [];
66:
67:
68: 69: 70: 71:
72: public static function dump($var, array $options = null)
73: {
74: if (PHP_SAPI !== 'cli' && !preg_match('#^Content-Type: (?!text/html)#im', implode("\n", headers_list()))) {
75: echo self::toHtml($var, $options);
76: } elseif (self::detectColors()) {
77: echo self::toTerminal($var, $options);
78: } else {
79: echo self::toText($var, $options);
80: }
81: return $var;
82: }
83:
84:
85: 86: 87: 88:
89: public static function toHtml($var, array $options = null)
90: {
91: $options = (array) $options + [
92: self::DEPTH => 4,
93: self::TRUNCATE => 150,
94: self::COLLAPSE => 14,
95: self::COLLAPSE_COUNT => 7,
96: self::OBJECT_EXPORTERS => null,
97: ];
98: $loc = &$options[self::LOCATION];
99: $loc = $loc === true ? ~0 : (int) $loc;
100:
101: $options[self::OBJECT_EXPORTERS] = (array) $options[self::OBJECT_EXPORTERS] + self::$objectExporters;
102: uksort($options[self::OBJECT_EXPORTERS], function ($a, $b) {
103: return $b === '' || (class_exists($a, false) && is_subclass_of($a, $b)) ? -1 : 1;
104: });
105:
106: $live = !empty($options[self::LIVE]) && $var && (is_array($var) || is_object($var) || is_resource($var));
107: list($file, $line, $code) = $loc ? self::findLocation() : null;
108: $locAttrs = $file && $loc & self::LOCATION_SOURCE ? Helpers::formatHtml(
109: ' title="%in file % on line %" data-tracy-href="%"', "$code\n", $file, $line, Helpers::editorUri($file, $line)
110: ) : null;
111:
112: return '<pre class="tracy-dump' . ($live && $options[self::COLLAPSE] === true ? ' tracy-collapsed' : '') . '"'
113: . $locAttrs
114: . ($live ? " data-tracy-dump='" . json_encode(self::toJson($var, $options), JSON_HEX_APOS | JSON_HEX_AMP) . "'>" : '>')
115: . ($live ? '' : self::dumpVar($var, $options))
116: . ($file && $loc & self::LOCATION_LINK ? '<small>in ' . Helpers::editorLink($file, $line) . '</small>' : '')
117: . "</pre>\n";
118: }
119:
120:
121: 122: 123: 124:
125: public static function toText($var, array $options = null)
126: {
127: return htmlspecialchars_decode(strip_tags(self::toHtml($var, $options)), ENT_QUOTES);
128: }
129:
130:
131: 132: 133: 134:
135: public static function toTerminal($var, array $options = null)
136: {
137: return htmlspecialchars_decode(strip_tags(preg_replace_callback('#<span class="tracy-dump-(\w+)">|</span>#', function ($m) {
138: return "\033[" . (isset($m[1], self::$terminalColors[$m[1]]) ? self::$terminalColors[$m[1]] : '0') . 'm';
139: }, self::toHtml($var, $options))), ENT_QUOTES);
140: }
141:
142:
143: 144: 145: 146: 147: 148: 149:
150: private static function dumpVar(&$var, array $options, $level = 0)
151: {
152: if (method_exists(__CLASS__, $m = 'dump' . gettype($var))) {
153: return self::$m($var, $options, $level);
154: } else {
155: return "<span>unknown type</span>\n";
156: }
157: }
158:
159:
160: private static function dumpNull()
161: {
162: return "<span class=\"tracy-dump-null\">null</span>\n";
163: }
164:
165:
166: private static function dumpBoolean(&$var)
167: {
168: return '<span class="tracy-dump-bool">' . ($var ? 'true' : 'false') . "</span>\n";
169: }
170:
171:
172: private static function dumpInteger(&$var)
173: {
174: return "<span class=\"tracy-dump-number\">$var</span>\n";
175: }
176:
177:
178: private static function dumpDouble(&$var)
179: {
180: $var = is_finite($var)
181: ? ($tmp = json_encode($var)) . (strpos($tmp, '.') === false ? '.0' : '')
182: : str_replace('.0', '', var_export($var, true));
183: return "<span class=\"tracy-dump-number\">$var</span>\n";
184: }
185:
186:
187: private static function dumpString(&$var, $options)
188: {
189: return '<span class="tracy-dump-string">"'
190: . Helpers::escapeHtml(self::encodeString($var, $options[self::TRUNCATE]))
191: . '"</span>' . (strlen($var) > 1 ? ' (' . strlen($var) . ')' : '') . "\n";
192: }
193:
194:
195: private static function dumpArray(&$var, $options, $level)
196: {
197: static $marker;
198: if ($marker === null) {
199: $marker = uniqid("\x00", true);
200: }
201:
202: $out = '<span class="tracy-dump-array">array</span> (';
203:
204: if (empty($var)) {
205: return $out . ")\n";
206:
207: } elseif (isset($var[$marker])) {
208: return $out . (count($var) - 1) . ") [ <i>RECURSION</i> ]\n";
209:
210: } elseif (!$options[self::DEPTH] || $level < $options[self::DEPTH]) {
211: $collapsed = $level ? count($var) >= $options[self::COLLAPSE_COUNT]
212: : (is_int($options[self::COLLAPSE]) ? count($var) >= $options[self::COLLAPSE] : $options[self::COLLAPSE]);
213: $out = '<span class="tracy-toggle' . ($collapsed ? ' tracy-collapsed' : '') . '">'
214: . $out . count($var) . ")</span>\n<div" . ($collapsed ? ' class="tracy-collapsed"' : '') . '>';
215: $var[$marker] = true;
216: foreach ($var as $k => &$v) {
217: if ($k !== $marker) {
218: $k = is_int($k) || preg_match('#^\w{1,50}\z#', $k) ? $k : '"' . Helpers::escapeHtml(self::encodeString($k, $options[self::TRUNCATE])) . '"';
219: $out .= '<span class="tracy-dump-indent"> ' . str_repeat('| ', $level) . '</span>'
220: . '<span class="tracy-dump-key">' . $k . '</span> => '
221: . self::dumpVar($v, $options, $level + 1);
222: }
223: }
224: unset($var[$marker]);
225: return $out . '</div>';
226:
227: } else {
228: return $out . count($var) . ") [ ... ]\n";
229: }
230: }
231:
232:
233: private static function dumpObject(&$var, $options, $level)
234: {
235: $fields = self::exportObject($var, $options[self::OBJECT_EXPORTERS]);
236: $editor = null;
237: if ($options[self::LOCATION] & self::LOCATION_CLASS) {
238: $rc = $var instanceof \Closure ? new \ReflectionFunction($var) : new \ReflectionClass($var);
239: $editor = Helpers::editorUri($rc->getFileName(), $rc->getStartLine());
240: }
241: $out = '<span class="tracy-dump-object"'
242: . ($editor ? Helpers::formatHtml(
243: ' title="Declared in file % on line %" data-tracy-href="%"', $rc->getFileName(), $rc->getStartLine(), $editor
244: ) : '')
245: . '>' . Helpers::escapeHtml(Helpers::getClass($var)) . '</span> <span class="tracy-dump-hash">#' . substr(md5(spl_object_hash($var)), 0, 4) . '</span>';
246:
247: static $list = [];
248:
249: if (empty($fields)) {
250: return $out . "\n";
251:
252: } elseif (in_array($var, $list, true)) {
253: return $out . " { <i>RECURSION</i> }\n";
254:
255: } elseif (!$options[self::DEPTH] || $level < $options[self::DEPTH] || $var instanceof \Closure) {
256: $collapsed = $level ? count($fields) >= $options[self::COLLAPSE_COUNT]
257: : (is_int($options[self::COLLAPSE]) ? count($fields) >= $options[self::COLLAPSE] : $options[self::COLLAPSE]);
258: $out = '<span class="tracy-toggle' . ($collapsed ? ' tracy-collapsed' : '') . '">'
259: . $out . "</span>\n<div" . ($collapsed ? ' class="tracy-collapsed"' : '') . '>';
260: $list[] = $var;
261: foreach ($fields as $k => &$v) {
262: $vis = '';
263: if (isset($k[0]) && $k[0] === "\x00") {
264: $vis = ' <span class="tracy-dump-visibility">' . ($k[1] === '*' ? 'protected' : 'private') . '</span>';
265: $k = substr($k, strrpos($k, "\x00") + 1);
266: }
267: $k = is_int($k) || preg_match('#^\w{1,50}\z#', $k) ? $k : '"' . Helpers::escapeHtml(self::encodeString($k, $options[self::TRUNCATE])) . '"';
268: $out .= '<span class="tracy-dump-indent"> ' . str_repeat('| ', $level) . '</span>'
269: . '<span class="tracy-dump-key">' . $k . "</span>$vis => "
270: . self::dumpVar($v, $options, $level + 1);
271: }
272: array_pop($list);
273: return $out . '</div>';
274:
275: } else {
276: return $out . " { ... }\n";
277: }
278: }
279:
280:
281: private static function dumpResource(&$var, $options, $level)
282: {
283: $type = get_resource_type($var);
284: $out = '<span class="tracy-dump-resource">' . Helpers::escapeHtml($type) . ' resource</span> '
285: . '<span class="tracy-dump-hash">#' . (int) $var . '</span>';
286: if (isset(self::$resources[$type])) {
287: $out = "<span class=\"tracy-toggle tracy-collapsed\">$out</span>\n<div class=\"tracy-collapsed\">";
288: foreach (call_user_func(self::$resources[$type], $var) as $k => $v) {
289: $out .= '<span class="tracy-dump-indent"> ' . str_repeat('| ', $level) . '</span>'
290: . '<span class="tracy-dump-key">' . Helpers::escapeHtml($k) . '</span> => ' . self::dumpVar($v, $options, $level + 1);
291: }
292: return $out . '</div>';
293: }
294: return "$out\n";
295: }
296:
297:
298: 299: 300:
301: private static function toJson(&$var, $options, $level = 0)
302: {
303: if (is_bool($var) || $var === null || is_int($var)) {
304: return $var;
305:
306: } elseif (is_float($var)) {
307: return is_finite($var)
308: ? (strpos($tmp = json_encode($var), '.') ? $var : ['number' => "$tmp.0"])
309: : ['type' => (string) $var];
310:
311: } elseif (is_string($var)) {
312: return self::encodeString($var, $options[self::TRUNCATE]);
313:
314: } elseif (is_array($var)) {
315: static $marker;
316: if ($marker === null) {
317: $marker = uniqid("\x00", true);
318: }
319: if (isset($var[$marker]) || $level >= $options[self::DEPTH]) {
320: return [null];
321: }
322: $res = [];
323: $var[$marker] = true;
324: foreach ($var as $k => &$v) {
325: if ($k !== $marker) {
326: $k = is_int($k) || preg_match('#^\w{1,50}\z#', $k) ? $k : '"' . self::encodeString($k, $options[self::TRUNCATE]) . '"';
327: $res[] = [$k, self::toJson($v, $options, $level + 1)];
328: }
329: }
330: unset($var[$marker]);
331: return $res;
332:
333: } elseif (is_object($var)) {
334: $obj = &self::$liveStorage[spl_object_hash($var)];
335: if ($obj && $obj['level'] <= $level) {
336: return ['object' => $obj['id']];
337: }
338:
339: if ($options[self::LOCATION] & self::LOCATION_CLASS) {
340: $rc = $var instanceof \Closure ? new \ReflectionFunction($var) : new \ReflectionClass($var);
341: $editor = Helpers::editorUri($rc->getFileName(), $rc->getStartLine());
342: }
343: static $counter = 1;
344: $obj = $obj ?: [
345: 'id' => self::$livePrefix . '0' . $counter++,
346: 'name' => Helpers::getClass($var),
347: 'editor' => empty($editor) ? null : ['file' => $rc->getFileName(), 'line' => $rc->getStartLine(), 'url' => $editor],
348: 'level' => $level,
349: 'object' => $var,
350: ];
351:
352: if ($level < $options[self::DEPTH] || !$options[self::DEPTH]) {
353: $obj['level'] = $level;
354: $obj['items'] = [];
355:
356: foreach (self::exportObject($var, $options[self::OBJECT_EXPORTERS]) as $k => $v) {
357: $vis = 0;
358: if (isset($k[0]) && $k[0] === "\x00") {
359: $vis = $k[1] === '*' ? 1 : 2;
360: $k = substr($k, strrpos($k, "\x00") + 1);
361: }
362: $k = is_int($k) || preg_match('#^\w{1,50}\z#', $k) ? $k : '"' . self::encodeString($k, $options[self::TRUNCATE]) . '"';
363: $obj['items'][] = [$k, self::toJson($v, $options, $level + 1), $vis];
364: }
365: }
366: return ['object' => $obj['id']];
367:
368: } elseif (is_resource($var)) {
369: $obj = &self::$liveStorage[(string) $var];
370: if (!$obj) {
371: $type = get_resource_type($var);
372: $obj = ['id' => self::$livePrefix . (int) $var, 'name' => $type . ' resource'];
373: if (isset(self::$resources[$type])) {
374: foreach (call_user_func(self::$resources[$type], $var) as $k => $v) {
375: $obj['items'][] = [$k, self::toJson($v, $options, $level + 1)];
376: }
377: }
378: }
379: return ['resource' => $obj['id']];
380:
381: } else {
382: return ['type' => 'unknown type'];
383: }
384: }
385:
386:
387:
388: public static function fetchLiveData()
389: {
390: $res = [];
391: foreach (self::$liveStorage as $obj) {
392: $id = $obj['id'];
393: unset($obj['level'], $obj['object'], $obj['id']);
394: $res[$id] = $obj;
395: }
396: self::$liveStorage = [];
397: return $res;
398: }
399:
400:
401: 402: 403: 404:
405: public static function encodeString($s, $maxLength = null)
406: {
407: static $table;
408: if ($table === null) {
409: foreach (array_merge(range("\x00", "\x1F"), range("\x7F", "\xFF")) as $ch) {
410: $table[$ch] = '\x' . str_pad(dechex(ord($ch)), 2, '0', STR_PAD_LEFT);
411: }
412: $table['\\'] = '\\\\';
413: $table["\r"] = '\r';
414: $table["\n"] = '\n';
415: $table["\t"] = '\t';
416: }
417:
418: if ($maxLength && strlen($s) > $maxLength) {
419: if (function_exists('mb_substr')) {
420: $s = mb_substr($tmp = $s, 0, $maxLength, 'UTF-8');
421: $shortened = $s !== $tmp;
422: } else {
423: $i = $len = 0;
424: $maxI = $maxLength * 4;
425: do {
426: if (($s[$i] < "\x80" || $s[$i] >= "\xC0") && (++$len > $maxLength) || $i >= $maxI) {
427: $s = substr($s, 0, $i);
428: $shortened = true;
429: break;
430: }
431: } while (isset($s[++$i]));
432: }
433: }
434:
435: if (preg_match('#[^\x09\x0A\x0D\x20-\x7E\xA0-\x{10FFFF}]#u', $s) || preg_last_error()) {
436: if ($maxLength && strlen($s) > $maxLength) {
437: $s = substr($s, 0, $maxLength);
438: $shortened = true;
439: }
440: $s = strtr($s, $table);
441: }
442:
443: return $s . (empty($shortened) ? '' : ' ... ');
444: }
445:
446:
447: 448: 449:
450: private static function exportObject($obj, array $exporters)
451: {
452: foreach ($exporters as $type => $dumper) {
453: if (!$type || $obj instanceof $type) {
454: return call_user_func($dumper, $obj);
455: }
456: }
457: return (array) $obj;
458: }
459:
460:
461: 462: 463:
464: private static function exportClosure(\Closure $obj)
465: {
466: $rc = new \ReflectionFunction($obj);
467: $res = [];
468: foreach ($rc->getParameters() as $param) {
469: $res[] = '$' . $param->getName();
470: }
471: return [
472: 'file' => $rc->getFileName(),
473: 'line' => $rc->getStartLine(),
474: 'variables' => $rc->getStaticVariables(),
475: 'parameters' => implode(', ', $res),
476: ];
477: }
478:
479:
480: 481: 482:
483: private static function exportSplFileInfo(\SplFileInfo $obj)
484: {
485: return ['path' => $obj->getPathname()];
486: }
487:
488:
489: 490: 491:
492: private static function exportSplObjectStorage(\SplObjectStorage $obj)
493: {
494: $res = [];
495: foreach (clone $obj as $item) {
496: $res[] = ['object' => $item, 'data' => $obj[$item]];
497: }
498: return $res;
499: }
500:
501:
502: 503: 504:
505: private static function exportPhpIncompleteClass(\__PHP_Incomplete_Class $obj)
506: {
507: $info = ['className' => null, 'private' => [], 'protected' => [], 'public' => []];
508: foreach ((array) $obj as $name => $value) {
509: if ($name === '__PHP_Incomplete_Class_Name') {
510: $info['className'] = $value;
511: } elseif (preg_match('#^\x0\*\x0(.+)\z#', $name, $m)) {
512: $info['protected'][$m[1]] = $value;
513: } elseif (preg_match('#^\x0(.+)\x0(.+)\z#', $name, $m)) {
514: $info['private'][$m[1] . '::$' . $m[2]] = $value;
515: } else {
516: $info['public'][$name] = $value;
517: }
518: }
519: return $info;
520: }
521:
522:
523: 524: 525: 526:
527: private static function findLocation()
528: {
529: foreach (debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS) as $item) {
530: if (isset($item['class']) && $item['class'] === __CLASS__) {
531: $location = $item;
532: continue;
533: } elseif (isset($item['function'])) {
534: try {
535: $reflection = isset($item['class'])
536: ? new \ReflectionMethod($item['class'], $item['function'])
537: : new \ReflectionFunction($item['function']);
538: if ($reflection->isInternal() || preg_match('#\s@tracySkipLocation\s#', (string) $reflection->getDocComment())) {
539: $location = $item;
540: continue;
541: }
542: } catch (\ReflectionException $e) {
543: }
544: }
545: break;
546: }
547:
548: if (isset($location['file'], $location['line']) && is_file($location['file'])) {
549: $lines = file($location['file']);
550: $line = $lines[$location['line'] - 1];
551: return [
552: $location['file'],
553: $location['line'],
554: trim(preg_match('#\w*dump(er::\w+)?\(.*\)#i', $line, $m) ? $m[0] : $line),
555: ];
556: }
557: }
558:
559:
560: 561: 562:
563: private static function detectColors()
564: {
565: return self::$terminalColors &&
566: (getenv('ConEmuANSI') === 'ON'
567: || getenv('ANSICON') !== false
568: || getenv('term') === 'xterm-256color'
569: || (defined('STDOUT') && function_exists('posix_isatty') && posix_isatty(STDOUT)));
570: }
571: }
572: