vendor/symfony/var-dumper/Caster/ExceptionCaster.php line 148

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\Caster;
  14. use Symfony\Component\Debug\Exception\SilencedErrorContext;
  15. use Symfony\Component\VarDumper\Cloner\Stub;
  16. use Symfony\Component\VarDumper\Exception\ThrowingCasterException;
  18. /**
  19.  * Casts common Exception classes to array representation.
  20.  *
  21.  * @author Nicolas Grekas <p@tchwork.com>
  22.  */
  23. class ExceptionCaster
  24. {
  25.     public static $srcContext = 1;
  26.     public static $traceArgs = true;
  27.     public static $errorTypes = [
  28.         E_DEPRECATED => 'E_DEPRECATED',
  29.         E_USER_DEPRECATED => 'E_USER_DEPRECATED',
  30.         E_RECOVERABLE_ERROR => 'E_RECOVERABLE_ERROR',
  31.         E_ERROR => 'E_ERROR',
  32.         E_WARNING => 'E_WARNING',
  33.         E_PARSE => 'E_PARSE',
  34.         E_NOTICE => 'E_NOTICE',
  35.         E_CORE_ERROR => 'E_CORE_ERROR',
  36.         E_CORE_WARNING => 'E_CORE_WARNING',
  37.         E_COMPILE_ERROR => 'E_COMPILE_ERROR',
  38.         E_COMPILE_WARNING => 'E_COMPILE_WARNING',
  39.         E_USER_ERROR => 'E_USER_ERROR',
  40.         E_USER_WARNING => 'E_USER_WARNING',
  41.         E_USER_NOTICE => 'E_USER_NOTICE',
  42.         E_STRICT => 'E_STRICT',
  43.     ];
  45.     private static $framesCache = [];
  47.     public static function castError(\Error $e, array $a, Stub $stub, $isNested, $filter = 0)
  48.     {
  49.         return self::filterExceptionArray($stub->class, $a, "\0Error\0", $filter);
  50.     }
  52.     public static function castException(\Exception $e, array $a, Stub $stub, $isNested, $filter = 0)
  53.     {
  54.         return self::filterExceptionArray($stub->class, $a, "\0Exception\0", $filter);
  55.     }
  57.     public static function castErrorException(\ErrorException $e, array $a, Stub $stub, $isNested)
  58.     {
  59.         if (isset($a[$s = Caster::PREFIX_PROTECTED.'severity'], self::$errorTypes[$a[$s]])) {
  60.             $a[$s] = new ConstStub(self::$errorTypes[$a[$s]], $a[$s]);
  61.         }
  63.         return $a;
  64.     }
  66.     public static function castThrowingCasterException(ThrowingCasterException $e, array $a, Stub $stub, $isNested)
  67.     {
  68.         $trace = Caster::PREFIX_VIRTUAL.'trace';
  69.         $prefix = Caster::PREFIX_PROTECTED;
  70.         $xPrefix = "\0Exception\0";
  72.         if (isset($a[$xPrefix.'previous'], $a[$trace]) && $a[$xPrefix.'previous'] instanceof \Exception) {
  73.             $b = (array) $a[$xPrefix.'previous'];
  74.             $class = \get_class($a[$xPrefix.'previous']);
  75.             $class = 'c' === $class[0] && 0 === strpos($class, "class@anonymous\0") ? get_parent_class($class).'@anonymous' : $class;
  76.             self::traceUnshift($b[$xPrefix.'trace'], $class, $b[$prefix.'file'], $b[$prefix.'line']);
  77.             $a[$trace] = new TraceStub($b[$xPrefix.'trace'], false, 0, -\count($a[$trace]->value));
  78.         }
  80.         unset($a[$xPrefix.'previous'], $a[$prefix.'code'], $a[$prefix.'file'], $a[$prefix.'line']);
  82.         return $a;
  83.     }
  85.     public static function castSilencedErrorContext(SilencedErrorContext $e, array $a, Stub $stub, $isNested)
  86.     {
  87.         $sPrefix = "\0".SilencedErrorContext::class."\0";
  89.         if (!isset($a[$s = $sPrefix.'severity'])) {
  90.             return $a;
  91.         }
  93.         if (isset(self::$errorTypes[$a[$s]])) {
  94.             $a[$s] = new ConstStub(self::$errorTypes[$a[$s]], $a[$s]);
  95.         }
  97.         $trace = [[
  98.             'file' => $a[$sPrefix.'file'],
  99.             'line' => $a[$sPrefix.'line'],
  100.         ]];
  102.         if (isset($a[$sPrefix.'trace'])) {
  103.             $trace = array_merge($trace, $a[$sPrefix.'trace']);
  104.         }
  106.         unset($a[$sPrefix.'file'], $a[$sPrefix.'line'], $a[$sPrefix.'trace']);
  107.         $a[Caster::PREFIX_VIRTUAL.'trace'] = new TraceStub($trace, self::$traceArgs);
  109.         return $a;
  110.     }
  112.     public static function castTraceStub(TraceStub $trace, array $a, Stub $stub, $isNested)
  113.     {
  114.         if (!$isNested) {
  115.             return $a;
  116.         }
  117.         $stub->class = '';
  118.         $stub->handle = 0;
  119.         $frames = $trace->value;
  120.         $prefix = Caster::PREFIX_VIRTUAL;
  122.         $a = [];
  123.         $j = \count($frames);
  124.         if (0 > $i = $trace->sliceOffset) {
  125.             $i = max(0, $j + $i);
  126.         }
  127.         if (!isset($trace->value[$i])) {
  128.             return [];
  129.         }
  130.         $lastCall = isset($frames[$i]['function']) ? (isset($frames[$i]['class']) ? $frames[0]['class'].$frames[$i]['type'] : '').$frames[$i]['function'].'()' : '';
  131.         $frames[] = ['function' => ''];
  132.         $collapse = false;
  134.         for ($j += $trace->numberingOffset - $i++; isset($frames[$i]); ++$i, --$j) {
  135.             $f = $frames[$i];
  136.             $call = isset($f['function']) ? (isset($f['class']) ? $f['class'].$f['type'] : '').$f['function'] : '???';
  138.             $frame = new FrameStub(
  139.                 [
  140.                     'object' => isset($f['object']) ? $f['object'] : null,
  141.                     'class' => isset($f['class']) ? $f['class'] : null,
  142.                     'type' => isset($f['type']) ? $f['type'] : null,
  143.                     'function' => isset($f['function']) ? $f['function'] : null,
  144.                 ] + $frames[$i - 1],
  145.                 false,
  146.                 true
  147.             );
  148.             $f = self::castFrameStub($frame, [], $frame, true);
  149.             if (isset($f[$prefix.'src'])) {
  150.                 foreach ($f[$prefix.'src']->value as $label => $frame) {
  151.                     if (0 === strpos($label, "\0~collapse=0")) {
  152.                         if ($collapse) {
  153.                             $label = substr_replace($label, '1', 11, 1);
  154.                         } else {
  155.                             $collapse = true;
  156.                         }
  157.                     }
  158.                     $label = substr_replace($label, "title=Stack level $j.&", 2, 0);
  159.                 }
  160.                 $f = $frames[$i - 1];
  161.                 if ($trace->keepArgs && !empty($f['args']) && $frame instanceof EnumStub) {
  162.                     $frame->value['arguments'] = new ArgsStub($f['args'], isset($f['function']) ? $f['function'] : null, isset($f['class']) ? $f['class'] : null);
  163.                 }
  164.             } elseif ('???' !== $lastCall) {
  165.                 $label = new ClassStub($lastCall);
  166.                 if (isset($label->attr['ellipsis'])) {
  167.                     $label->attr['ellipsis'] += 2;
  168.                     $label = substr_replace($prefix, "ellipsis-type=class&ellipsis={$label->attr['ellipsis']}&ellipsis-tail=1&title=Stack level $j.", 2, 0).$label->value.'()';
  169.                 } else {
  170.                     $label = substr_replace($prefix, "title=Stack level $j.", 2, 0).$label->value.'()';
  171.                 }
  172.             } else {
  173.                 $label = substr_replace($prefix, "title=Stack level $j.", 2, 0).$lastCall;
  174.             }
  175.             $a[substr_replace($label, sprintf('separator=%s&', $frame instanceof EnumStub ? ' ' : ':'), 2, 0)] = $frame;
  177.             $lastCall = $call;
  178.         }
  179.         if (null !== $trace->sliceLength) {
  180.             $a = \array_slice($a, 0, $trace->sliceLength, true);
  181.         }
  183.         return $a;
  184.     }
  186.     public static function castFrameStub(FrameStub $frame, array $a, Stub $stub, $isNested)
  187.     {
  188.         if (!$isNested) {
  189.             return $a;
  190.         }
  191.         $f = $frame->value;
  192.         $prefix = Caster::PREFIX_VIRTUAL;
  194.         if (isset($f['file'], $f['line'])) {
  195.             $cacheKey = $f;
  196.             unset($cacheKey['object'], $cacheKey['args']);
  197.             $cacheKey[] = self::$srcContext;
  198.             $cacheKey = implode('-', $cacheKey);
  200.             if (isset(self::$framesCache[$cacheKey])) {
  201.                 $a[$prefix.'src'] = self::$framesCache[$cacheKey];
  202.             } else {
  203.                 if (preg_match('/\((\d+)\)(?:\([\da-f]{32}\))? : (?:eval\(\)\'d code|runtime-created function)$/', $f['file'], $match)) {
  204.                     $f['file'] = substr($f['file'], 0, -\strlen($match[0]));
  205.                     $f['line'] = (int) $match[1];
  206.                 }
  207.                 $caller = isset($f['function']) ? sprintf('in %s() on line %d', (isset($f['class']) ? $f['class'].$f['type'] : '').$f['function'], $f['line']) : null;
  208.                 $src = $f['line'];
  209.                 $srcKey = $f['file'];
  210.                 $ellipsis = new LinkStub($srcKey, 0);
  211.                 $srcAttr = 'collapse='.(int) $ellipsis->inVendor;
  212.                 $ellipsisTail = isset($ellipsis->attr['ellipsis-tail']) ? $ellipsis->attr['ellipsis-tail'] : 0;
  213.                 $ellipsis = isset($ellipsis->attr['ellipsis']) ? $ellipsis->attr['ellipsis'] : 0;
  215.                 if (file_exists($f['file']) && 0 <= self::$srcContext) {
  216.                     if (!empty($f['class']) && (is_subclass_of($f['class'], 'Twig\Template') || is_subclass_of($f['class'], 'Twig_Template')) && method_exists($f['class'], 'getDebugInfo')) {
  217.                         $template = isset($f['object']) ? $f['object'] : unserialize(sprintf('O:%d:"%s":0:{}', \strlen($f['class']), $f['class']));
  219.                         $ellipsis = 0;
  220.                         $templateSrc = method_exists($template, 'getSourceContext') ? $template->getSourceContext()->getCode() : (method_exists($template, 'getSource') ? $template->getSource() : '');
  221.                         $templateInfo = $template->getDebugInfo();
  222.                         if (isset($templateInfo[$f['line']])) {
  223.                             if (!method_exists($template, 'getSourceContext') || !file_exists($templatePath = $template->getSourceContext()->getPath())) {
  224.                                 $templatePath = null;
  225.                             }
  226.                             if ($templateSrc) {
  227.                                 $src = self::extractSource($templateSrc, $templateInfo[$f['line']], self::$srcContext, $caller, 'twig', $templatePath);
  228.                                 $srcKey = ($templatePath ?: $template->getTemplateName()).':'.$templateInfo[$f['line']];
  229.                             }
  230.                         }
  231.                     }
  232.                     if ($srcKey == $f['file']) {
  233.                         $src = self::extractSource(file_get_contents($f['file']), $f['line'], self::$srcContext, $caller, 'php', $f['file']);
  234.                         $srcKey .= ':'.$f['line'];
  235.                         if ($ellipsis) {
  236.                             $ellipsis += 1 + \strlen($f['line']);
  237.                         }
  238.                     }
  239.                     $srcAttr .= '&separator= ';
  240.                 } else {
  241.                     $srcAttr .= '&separator=:';
  242.                 }
  243.                 $srcAttr .= $ellipsis ? '&ellipsis-type=path&ellipsis='.$ellipsis.'&ellipsis-tail='.$ellipsisTail : '';
  244.                 self::$framesCache[$cacheKey] = $a[$prefix.'src'] = new EnumStub(["\0~$srcAttr\0$srcKey" => $src]);
  245.             }
  246.         }
  248.         unset($a[$prefix.'args'], $a[$prefix.'line'], $a[$prefix.'file']);
  249.         if ($frame->inTraceStub) {
  250.             unset($a[$prefix.'class'], $a[$prefix.'type'], $a[$prefix.'function']);
  251.         }
  252.         foreach ($a as $k => $v) {
  253.             if (!$v) {
  254.                 unset($a[$k]);
  255.             }
  256.         }
  257.         if ($frame->keepArgs && !empty($f['args'])) {
  258.             $a[$prefix.'arguments'] = new ArgsStub($f['args'], $f['function'], $f['class']);
  259.         }
  261.         return $a;
  262.     }
  264.     private static function filterExceptionArray($xClass, array $a, $xPrefix, $filter)
  265.     {
  266.         if (isset($a[$xPrefix.'trace'])) {
  267.             $trace = $a[$xPrefix.'trace'];
  268.             unset($a[$xPrefix.'trace']); // Ensures the trace is always last
  269.         } else {
  270.             $trace = [];
  271.         }
  273.         if (!($filter & Caster::EXCLUDE_VERBOSE) && $trace) {
  274.             if (isset($a[Caster::PREFIX_PROTECTED.'file'], $a[Caster::PREFIX_PROTECTED.'line'])) {
  275.                 self::traceUnshift($trace, $xClass, $a[Caster::PREFIX_PROTECTED.'file'], $a[Caster::PREFIX_PROTECTED.'line']);
  276.             }
  277.             $a[Caster::PREFIX_VIRTUAL.'trace'] = new TraceStub($trace, self::$traceArgs);
  278.         }
  279.         if (empty($a[$xPrefix.'previous'])) {
  280.             unset($a[$xPrefix.'previous']);
  281.         }
  282.         unset($a[$xPrefix.'string'], $a[Caster::PREFIX_DYNAMIC.'xdebug_message'], $a[Caster::PREFIX_DYNAMIC.'__destructorException']);
  284.         if (isset($a[Caster::PREFIX_PROTECTED.'message']) && false !== strpos($a[Caster::PREFIX_PROTECTED.'message'], "class@anonymous\0")) {
  285.             $a[Caster::PREFIX_PROTECTED.'message'] = preg_replace_callback('/class@anonymous\x00.*?\.php0x?[0-9a-fA-F]++/', function ($m) {
  286.                 return \class_exists($m[0], false) ? get_parent_class($m[0]).'@anonymous' : $m[0];
  287.             }, $a[Caster::PREFIX_PROTECTED.'message']);
  288.         }
  290.         if (isset($a[Caster::PREFIX_PROTECTED.'file'], $a[Caster::PREFIX_PROTECTED.'line'])) {
  291.             $a[Caster::PREFIX_PROTECTED.'file'] = new LinkStub($a[Caster::PREFIX_PROTECTED.'file'], $a[Caster::PREFIX_PROTECTED.'line']);
  292.         }
  294.         return $a;
  295.     }
  297.     private static function traceUnshift(&$trace, $class, $file, $line)
  298.     {
  299.         if (isset($trace[0]['file'], $trace[0]['line']) && $trace[0]['file'] === $file && $trace[0]['line'] === $line) {
  300.             return;
  301.         }
  302.         array_unshift($trace, [
  303.             'function' => $class ? 'new '.$class : null,
  304.             'file' => $file,
  305.             'line' => $line,
  306.         ]);
  307.     }
  309.     private static function extractSource($srcLines, $line, $srcContext, $title, $lang, $file = null)
  310.     {
  311.         $srcLines = explode("\n", $srcLines);
  312.         $src = [];
  314.         for ($i = $line - 1 - $srcContext; $i <= $line - 1 + $srcContext; ++$i) {
  315.             $src[] = (isset($srcLines[$i]) ? $srcLines[$i] : '')."\n";
  316.         }
  318.         $srcLines = [];
  319.         $ltrim = 0;
  320.         do {
  321.             $pad = null;
  322.             for ($i = $srcContext << 1; $i >= 0; --$i) {
  323.                 if (isset($src[$i][$ltrim]) && "\r" !== ($c = $src[$i][$ltrim]) && "\n" !== $c) {
  324.                     if (null === $pad) {
  325.                         $pad = $c;
  326.                     }
  327.                     if ((' ' !== $c && "\t" !== $c) || $pad !== $c) {
  328.                         break;
  329.                     }
  330.                 }
  331.             }
  332.             ++$ltrim;
  333.         } while (0 > $i && null !== $pad);
  335.         --$ltrim;
  337.         foreach ($src as $i => $c) {
  338.             if ($ltrim) {
  339.                 $c = isset($c[$ltrim]) && "\r" !== $c[$ltrim] ? substr($c, $ltrim) : ltrim($c, " \t");
  340.             }
  341.             $c = substr($c, 0, -1);
  342.             if ($i !== $srcContext) {
  343.                 $c = new ConstStub('default', $c);
  344.             } else {
  345.                 $c = new ConstStub($c, $title);
  346.                 if (null !== $file) {
  347.                     $c->attr['file'] = $file;
  348.                     $c->attr['line'] = $line;
  349.                 }
  350.             }
  351.             $c->attr['lang'] = $lang;
  352.             $srcLines[sprintf("\0~separator=› &%d\0", $i + $line - $srcContext)] = $c;
  353.         }
  355.         return new EnumStub($srcLines);
  356.     }
  357. }