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

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\ErrorHandler\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.  * @final since Symfony 4.4
  24.  */
  25. class ExceptionCaster
  26. {
  27.     public static $srcContext = 1;
  28.     public static $traceArgs = true;
  29.     public static $errorTypes = [
  30.         E_DEPRECATED => 'E_DEPRECATED',
  31.         E_USER_DEPRECATED => 'E_USER_DEPRECATED',
  32.         E_RECOVERABLE_ERROR => 'E_RECOVERABLE_ERROR',
  33.         E_ERROR => 'E_ERROR',
  34.         E_WARNING => 'E_WARNING',
  35.         E_PARSE => 'E_PARSE',
  36.         E_NOTICE => 'E_NOTICE',
  37.         E_CORE_ERROR => 'E_CORE_ERROR',
  38.         E_CORE_WARNING => 'E_CORE_WARNING',
  39.         E_COMPILE_ERROR => 'E_COMPILE_ERROR',
  40.         E_COMPILE_WARNING => 'E_COMPILE_WARNING',
  41.         E_USER_ERROR => 'E_USER_ERROR',
  42.         E_USER_WARNING => 'E_USER_WARNING',
  43.         E_USER_NOTICE => 'E_USER_NOTICE',
  44.         E_STRICT => 'E_STRICT',
  45.     ];
  47.     private static $framesCache = [];
  49.     public static function castError(\Error $e, array $a, Stub $stub, $isNested, $filter = 0)
  50.     {
  51.         return self::filterExceptionArray($stub->class, $a, "\0Error\0", $filter);
  52.     }
  54.     public static function castException(\Exception $e, array $a, Stub $stub, $isNested, $filter = 0)
  55.     {
  56.         return self::filterExceptionArray($stub->class, $a, "\0Exception\0", $filter);
  57.     }
  59.     public static function castErrorException(\ErrorException $e, array $a, Stub $stub, $isNested)
  60.     {
  61.         if (isset($a[$s = Caster::PREFIX_PROTECTED.'severity'], self::$errorTypes[$a[$s]])) {
  62.             $a[$s] = new ConstStub(self::$errorTypes[$a[$s]], $a[$s]);
  63.         }
  65.         return $a;
  66.     }
  68.     public static function castThrowingCasterException(ThrowingCasterException $e, array $a, Stub $stub, $isNested)
  69.     {
  70.         $trace = Caster::PREFIX_VIRTUAL.'trace';
  71.         $prefix = Caster::PREFIX_PROTECTED;
  72.         $xPrefix = "\0Exception\0";
  74.         if (isset($a[$xPrefix.'previous'], $a[$trace]) && $a[$xPrefix.'previous'] instanceof \Exception) {
  75.             $b = (array) $a[$xPrefix.'previous'];
  76.             $class = \get_class($a[$xPrefix.'previous']);
  77.             $class = 'c' === $class[0] && 0 === strpos($class, "class@anonymous\0") ? get_parent_class($class).'@anonymous' : $class;
  78.             self::traceUnshift($b[$xPrefix.'trace'], $class, $b[$prefix.'file'], $b[$prefix.'line']);
  79.             $a[$trace] = new TraceStub($b[$xPrefix.'trace'], false, 0, -\count($a[$trace]->value));
  80.         }
  82.         unset($a[$xPrefix.'previous'], $a[$prefix.'code'], $a[$prefix.'file'], $a[$prefix.'line']);
  84.         return $a;
  85.     }
  87.     public static function castSilencedErrorContext(SilencedErrorContext $e, array $a, Stub $stub, $isNested)
  88.     {
  89.         $sPrefix = "\0".SilencedErrorContext::class."\0";
  91.         if (!isset($a[$s = $sPrefix.'severity'])) {
  92.             return $a;
  93.         }
  95.         if (isset(self::$errorTypes[$a[$s]])) {
  96.             $a[$s] = new ConstStub(self::$errorTypes[$a[$s]], $a[$s]);
  97.         }
  99.         $trace = [[
  100.             'file' => $a[$sPrefix.'file'],
  101.             'line' => $a[$sPrefix.'line'],
  102.         ]];
  104.         if (isset($a[$sPrefix.'trace'])) {
  105.             $trace = array_merge($trace, $a[$sPrefix.'trace']);
  106.         }
  108.         unset($a[$sPrefix.'file'], $a[$sPrefix.'line'], $a[$sPrefix.'trace']);
  109.         $a[Caster::PREFIX_VIRTUAL.'trace'] = new TraceStub($trace, self::$traceArgs);
  111.         return $a;
  112.     }
  114.     public static function castTraceStub(TraceStub $trace, array $a, Stub $stub, $isNested)
  115.     {
  116.         if (!$isNested) {
  117.             return $a;
  118.         }
  119.         $stub->class = '';
  120.         $stub->handle = 0;
  121.         $frames = $trace->value;
  122.         $prefix = Caster::PREFIX_VIRTUAL;
  124.         $a = [];
  125.         $j = \count($frames);
  126.         if (0 > $i = $trace->sliceOffset) {
  127.             $i = max(0, $j + $i);
  128.         }
  129.         if (!isset($trace->value[$i])) {
  130.             return [];
  131.         }
  132.         $lastCall = isset($frames[$i]['function']) ? (isset($frames[$i]['class']) ? $frames[0]['class'].$frames[$i]['type'] : '').$frames[$i]['function'].'()' : '';
  133.         $frames[] = ['function' => ''];
  134.         $collapse = false;
  136.         for ($j += $trace->numberingOffset - $i++; isset($frames[$i]); ++$i, --$j) {
  137.             $f = $frames[$i];
  138.             $call = isset($f['function']) ? (isset($f['class']) ? $f['class'].$f['type'] : '').$f['function'] : '???';
  140.             $frame = new FrameStub(
  141.                 [
  142.                     'object' => isset($f['object']) ? $f['object'] : null,
  143.                     'class' => isset($f['class']) ? $f['class'] : null,
  144.                     'type' => isset($f['type']) ? $f['type'] : null,
  145.                     'function' => isset($f['function']) ? $f['function'] : null,
  146.                 ] + $frames[$i - 1],
  147.                 false,
  148.                 true
  149.             );
  150.             $f = self::castFrameStub($frame, [], $frame, true);
  151.             if (isset($f[$prefix.'src'])) {
  152.                 foreach ($f[$prefix.'src']->value as $label => $frame) {
  153.                     if (0 === strpos($label, "\0~collapse=0")) {
  154.                         if ($collapse) {
  155.                             $label = substr_replace($label, '1', 11, 1);
  156.                         } else {
  157.                             $collapse = true;
  158.                         }
  159.                     }
  160.                     $label = substr_replace($label, "title=Stack level $j.&", 2, 0);
  161.                 }
  162.                 $f = $frames[$i - 1];
  163.                 if ($trace->keepArgs && !empty($f['args']) && $frame instanceof EnumStub) {
  164.                     $frame->value['arguments'] = new ArgsStub($f['args'], isset($f['function']) ? $f['function'] : null, isset($f['class']) ? $f['class'] : null);
  165.                 }
  166.             } elseif ('???' !== $lastCall) {
  167.                 $label = new ClassStub($lastCall);
  168.                 if (isset($label->attr['ellipsis'])) {
  169.                     $label->attr['ellipsis'] += 2;
  170.                     $label = substr_replace($prefix, "ellipsis-type=class&ellipsis={$label->attr['ellipsis']}&ellipsis-tail=1&title=Stack level $j.", 2, 0).$label->value.'()';
  171.                 } else {
  172.                     $label = substr_replace($prefix, "title=Stack level $j.", 2, 0).$label->value.'()';
  173.                 }
  174.             } else {
  175.                 $label = substr_replace($prefix, "title=Stack level $j.", 2, 0).$lastCall;
  176.             }
  177.             $a[substr_replace($label, sprintf('separator=%s&', $frame instanceof EnumStub ? ' ' : ':'), 2, 0)] = $frame;
  179.             $lastCall = $call;
  180.         }
  181.         if (null !== $trace->sliceLength) {
  182.             $a = \array_slice($a, 0, $trace->sliceLength, true);
  183.         }
  185.         return $a;
  186.     }
  188.     public static function castFrameStub(FrameStub $frame, array $a, Stub $stub, $isNested)
  189.     {
  190.         if (!$isNested) {
  191.             return $a;
  192.         }
  193.         $f = $frame->value;
  194.         $prefix = Caster::PREFIX_VIRTUAL;
  196.         if (isset($f['file'], $f['line'])) {
  197.             $cacheKey = $f;
  198.             unset($cacheKey['object'], $cacheKey['args']);
  199.             $cacheKey[] = self::$srcContext;
  200.             $cacheKey = implode('-', $cacheKey);
  202.             if (isset(self::$framesCache[$cacheKey])) {
  203.                 $a[$prefix.'src'] = self::$framesCache[$cacheKey];
  204.             } else {
  205.                 if (preg_match('/\((\d+)\)(?:\([\da-f]{32}\))? : (?:eval\(\)\'d code|runtime-created function)$/', $f['file'], $match)) {
  206.                     $f['file'] = substr($f['file'], 0, -\strlen($match[0]));
  207.                     $f['line'] = (int) $match[1];
  208.                 }
  209.                 $src = $f['line'];
  210.                 $srcKey = $f['file'];
  211.                 $ellipsis = new LinkStub($srcKey, 0);
  212.                 $srcAttr = 'collapse='.(int) $ellipsis->inVendor;
  213.                 $ellipsisTail = isset($ellipsis->attr['ellipsis-tail']) ? $ellipsis->attr['ellipsis-tail'] : 0;
  214.                 $ellipsis = isset($ellipsis->attr['ellipsis']) ? $ellipsis->attr['ellipsis'] : 0;
  216.                 if (file_exists($f['file']) && 0 <= self::$srcContext) {
  217.                     if (!empty($f['class']) && (is_subclass_of($f['class'], 'Twig\Template') || is_subclass_of($f['class'], 'Twig_Template')) && method_exists($f['class'], 'getDebugInfo')) {
  218.                         $template = isset($f['object']) ? $f['object'] : unserialize(sprintf('O:%d:"%s":0:{}', \strlen($f['class']), $f['class']));
  220.                         $ellipsis = 0;
  221.                         $templateSrc = method_exists($template, 'getSourceContext') ? $template->getSourceContext()->getCode() : (method_exists($template, 'getSource') ? $template->getSource() : '');
  222.                         $templateInfo = $template->getDebugInfo();
  223.                         if (isset($templateInfo[$f['line']])) {
  224.                             if (!method_exists($template, 'getSourceContext') || !file_exists($templatePath = $template->getSourceContext()->getPath())) {
  225.                                 $templatePath = null;
  226.                             }
  227.                             if ($templateSrc) {
  228.                                 $src = self::extractSource($templateSrc, $templateInfo[$f['line']], self::$srcContext, 'twig', $templatePath, $f);
  229.                                 $srcKey = ($templatePath ?: $template->getTemplateName()).':'.$templateInfo[$f['line']];
  230.                             }
  231.                         }
  232.                     }
  233.                     if ($srcKey == $f['file']) {
  234.                         $src = self::extractSource(file_get_contents($f['file']), $f['line'], self::$srcContext, 'php', $f['file'], $f);
  235.                         $srcKey .= ':'.$f['line'];
  236.                         if ($ellipsis) {
  237.                             $ellipsis += 1 + \strlen($f['line']);
  238.                         }
  239.                     }
  240.                     $srcAttr .= sprintf('&separator= &file=%s&line=%d', rawurlencode($f['file']), $f['line']);
  241.                 } else {
  242.                     $srcAttr .= '&separator=:';
  243.                 }
  244.                 $srcAttr .= $ellipsis ? '&ellipsis-type=path&ellipsis='.$ellipsis.'&ellipsis-tail='.$ellipsisTail : '';
  245.                 self::$framesCache[$cacheKey] = $a[$prefix.'src'] = new EnumStub(["\0~$srcAttr\0$srcKey" => $src]);
  246.             }
  247.         }
  249.         unset($a[$prefix.'args'], $a[$prefix.'line'], $a[$prefix.'file']);
  250.         if ($frame->inTraceStub) {
  251.             unset($a[$prefix.'class'], $a[$prefix.'type'], $a[$prefix.'function']);
  252.         }
  253.         foreach ($a as $k => $v) {
  254.             if (!$v) {
  255.                 unset($a[$k]);
  256.             }
  257.         }
  258.         if ($frame->keepArgs && !empty($f['args'])) {
  259.             $a[$prefix.'arguments'] = new ArgsStub($f['args'], $f['function'], $f['class']);
  260.         }
  262.         return $a;
  263.     }
  265.     private static function filterExceptionArray(string $xClass, array $a, string $xPrefix, int $filter): array
  266.     {
  267.         if (isset($a[$xPrefix.'trace'])) {
  268.             $trace = $a[$xPrefix.'trace'];
  269.             unset($a[$xPrefix.'trace']); // Ensures the trace is always last
  270.         } else {
  271.             $trace = [];
  272.         }
  274.         if (!($filter & Caster::EXCLUDE_VERBOSE) && $trace) {
  275.             if (isset($a[Caster::PREFIX_PROTECTED.'file'], $a[Caster::PREFIX_PROTECTED.'line'])) {
  276.                 self::traceUnshift($trace, $xClass, $a[Caster::PREFIX_PROTECTED.'file'], $a[Caster::PREFIX_PROTECTED.'line']);
  277.             }
  278.             $a[Caster::PREFIX_VIRTUAL.'trace'] = new TraceStub($trace, self::$traceArgs);
  279.         }
  280.         if (empty($a[$xPrefix.'previous'])) {
  281.             unset($a[$xPrefix.'previous']);
  282.         }
  283.         unset($a[$xPrefix.'string'], $a[Caster::PREFIX_DYNAMIC.'xdebug_message'], $a[Caster::PREFIX_DYNAMIC.'__destructorException']);
  285.         if (isset($a[Caster::PREFIX_PROTECTED.'message']) && false !== strpos($a[Caster::PREFIX_PROTECTED.'message'], "class@anonymous\0")) {
  286.             $a[Caster::PREFIX_PROTECTED.'message'] = preg_replace_callback('/class@anonymous\x00.*?\.php(?:0x?|:[0-9]++\$)[0-9a-fA-F]++/', function ($m) {
  287.                 return class_exists($m[0], false) ? get_parent_class($m[0]).'@anonymous' : $m[0];
  288.             }, $a[Caster::PREFIX_PROTECTED.'message']);
  289.         }
  291.         if (isset($a[Caster::PREFIX_PROTECTED.'file'], $a[Caster::PREFIX_PROTECTED.'line'])) {
  292.             $a[Caster::PREFIX_PROTECTED.'file'] = new LinkStub($a[Caster::PREFIX_PROTECTED.'file'], $a[Caster::PREFIX_PROTECTED.'line']);
  293.         }
  295.         return $a;
  296.     }
  298.     private static function traceUnshift(array &$trace, ?string $class, string $file, int $line): void
  299.     {
  300.         if (isset($trace[0]['file'], $trace[0]['line']) && $trace[0]['file'] === $file && $trace[0]['line'] === $line) {
  301.             return;
  302.         }
  303.         array_unshift($trace, [
  304.             'function' => $class ? 'new '.$class : null,
  305.             'file' => $file,
  306.             'line' => $line,
  307.         ]);
  308.     }
  310.     private static function extractSource(string $srcLines, int $line, int $srcContext, string $lang, ?string $file, array $frame): EnumStub
  311.     {
  312.         $srcLines = explode("\n", $srcLines);
  313.         $src = [];
  315.         for ($i = $line - 1 - $srcContext; $i <= $line - 1 + $srcContext; ++$i) {
  316.             $src[] = (isset($srcLines[$i]) ? $srcLines[$i] : '')."\n";
  317.         }
  319.         if ($frame['function'] ?? false) {
  320.             $stub = new CutStub(new \stdClass());
  321.             $stub->class = (isset($frame['class']) ? $frame['class'].$frame['type'] : '').$frame['function'];
  322.             $stub->type = Stub::TYPE_OBJECT;
  323.             $stub->attr['cut_hash'] = true;
  324.             $stub->attr['file'] = $frame['file'];
  325.             $stub->attr['line'] = $frame['line'];
  327.             try {
  328.                 $caller = isset($frame['class']) ? new \ReflectionMethod($frame['class'], $frame['function']) : new \ReflectionFunction($frame['function']);
  329.                 $stub->class .= ReflectionCaster::getSignature(ReflectionCaster::castFunctionAbstract($caller, [], $stub, true, Caster::EXCLUDE_VERBOSE));
  331.                 if ($f = $caller->getFileName()) {
  332.                     $stub->attr['file'] = $f;
  333.                     $stub->attr['line'] = $caller->getStartLine();
  334.                 }
  335.             } catch (\ReflectionException $e) {
  336.                 // ignore fake class/function
  337.             }
  339.             $srcLines = ["\0~separator=\0" => $stub];
  340.         } else {
  341.             $stub = null;
  342.             $srcLines = [];
  343.         }
  345.         $ltrim = 0;
  346.         do {
  347.             $pad = null;
  348.             for ($i = $srcContext << 1; $i >= 0; --$i) {
  349.                 if (isset($src[$i][$ltrim]) && "\r" !== ($c = $src[$i][$ltrim]) && "\n" !== $c) {
  350.                     if (null === $pad) {
  351.                         $pad = $c;
  352.                     }
  353.                     if ((' ' !== $c && "\t" !== $c) || $pad !== $c) {
  354.                         break;
  355.                     }
  356.                 }
  357.             }
  358.             ++$ltrim;
  359.         } while (0 > $i && null !== $pad);
  361.         --$ltrim;
  363.         foreach ($src as $i => $c) {
  364.             if ($ltrim) {
  365.                 $c = isset($c[$ltrim]) && "\r" !== $c[$ltrim] ? substr($c, $ltrim) : ltrim($c, " \t");
  366.             }
  367.             $c = substr($c, 0, -1);
  368.             if ($i !== $srcContext) {
  369.                 $c = new ConstStub('default', $c);
  370.             } else {
  371.                 $c = new ConstStub($c, $stub ? 'in '.$stub->class : '');
  372.                 if (null !== $file) {
  373.                     $c->attr['file'] = $file;
  374.                     $c->attr['line'] = $line;
  375.                 }
  376.             }
  377.             $c->attr['lang'] = $lang;
  378.             $srcLines[sprintf("\0~separator=› &%d\0", $i + $line - $srcContext)] = $c;
  379.         }
  381.         return new EnumStub($srcLines);
  382.     }
  383. }