Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\VarDumper\Caster;
Chris@0: 
Chris@0: use Symfony\Component\Debug\Exception\SilencedErrorContext;
Chris@17: use Symfony\Component\VarDumper\Cloner\Stub;
Chris@0: use Symfony\Component\VarDumper\Exception\ThrowingCasterException;
Chris@0: 
Chris@0: /**
Chris@0:  * Casts common Exception classes to array representation.
Chris@0:  *
Chris@0:  * @author Nicolas Grekas <p@tchwork.com>
Chris@0:  */
Chris@0: class ExceptionCaster
Chris@0: {
Chris@0:     public static $srcContext = 1;
Chris@0:     public static $traceArgs = true;
Chris@17:     public static $errorTypes = [
Chris@0:         E_DEPRECATED => 'E_DEPRECATED',
Chris@0:         E_USER_DEPRECATED => 'E_USER_DEPRECATED',
Chris@0:         E_RECOVERABLE_ERROR => 'E_RECOVERABLE_ERROR',
Chris@0:         E_ERROR => 'E_ERROR',
Chris@0:         E_WARNING => 'E_WARNING',
Chris@0:         E_PARSE => 'E_PARSE',
Chris@0:         E_NOTICE => 'E_NOTICE',
Chris@0:         E_CORE_ERROR => 'E_CORE_ERROR',
Chris@0:         E_CORE_WARNING => 'E_CORE_WARNING',
Chris@0:         E_COMPILE_ERROR => 'E_COMPILE_ERROR',
Chris@0:         E_COMPILE_WARNING => 'E_COMPILE_WARNING',
Chris@0:         E_USER_ERROR => 'E_USER_ERROR',
Chris@0:         E_USER_WARNING => 'E_USER_WARNING',
Chris@0:         E_USER_NOTICE => 'E_USER_NOTICE',
Chris@0:         E_STRICT => 'E_STRICT',
Chris@17:     ];
Chris@0: 
Chris@17:     private static $framesCache = [];
Chris@0: 
Chris@0:     public static function castError(\Error $e, array $a, Stub $stub, $isNested, $filter = 0)
Chris@0:     {
Chris@0:         return self::filterExceptionArray($stub->class, $a, "\0Error\0", $filter);
Chris@0:     }
Chris@0: 
Chris@0:     public static function castException(\Exception $e, array $a, Stub $stub, $isNested, $filter = 0)
Chris@0:     {
Chris@0:         return self::filterExceptionArray($stub->class, $a, "\0Exception\0", $filter);
Chris@0:     }
Chris@0: 
Chris@0:     public static function castErrorException(\ErrorException $e, array $a, Stub $stub, $isNested)
Chris@0:     {
Chris@0:         if (isset($a[$s = Caster::PREFIX_PROTECTED.'severity'], self::$errorTypes[$a[$s]])) {
Chris@0:             $a[$s] = new ConstStub(self::$errorTypes[$a[$s]], $a[$s]);
Chris@0:         }
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: 
Chris@0:     public static function castThrowingCasterException(ThrowingCasterException $e, array $a, Stub $stub, $isNested)
Chris@0:     {
Chris@0:         $trace = Caster::PREFIX_VIRTUAL.'trace';
Chris@0:         $prefix = Caster::PREFIX_PROTECTED;
Chris@0:         $xPrefix = "\0Exception\0";
Chris@0: 
Chris@0:         if (isset($a[$xPrefix.'previous'], $a[$trace]) && $a[$xPrefix.'previous'] instanceof \Exception) {
Chris@0:             $b = (array) $a[$xPrefix.'previous'];
Chris@17:             self::traceUnshift($b[$xPrefix.'trace'], \get_class($a[$xPrefix.'previous']), $b[$prefix.'file'], $b[$prefix.'line']);
Chris@17:             $a[$trace] = new TraceStub($b[$xPrefix.'trace'], false, 0, -\count($a[$trace]->value));
Chris@0:         }
Chris@0: 
Chris@0:         unset($a[$xPrefix.'previous'], $a[$prefix.'code'], $a[$prefix.'file'], $a[$prefix.'line']);
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: 
Chris@0:     public static function castSilencedErrorContext(SilencedErrorContext $e, array $a, Stub $stub, $isNested)
Chris@0:     {
Chris@0:         $sPrefix = "\0".SilencedErrorContext::class."\0";
Chris@0: 
Chris@0:         if (!isset($a[$s = $sPrefix.'severity'])) {
Chris@0:             return $a;
Chris@0:         }
Chris@0: 
Chris@0:         if (isset(self::$errorTypes[$a[$s]])) {
Chris@0:             $a[$s] = new ConstStub(self::$errorTypes[$a[$s]], $a[$s]);
Chris@0:         }
Chris@0: 
Chris@17:         $trace = [[
Chris@0:             'file' => $a[$sPrefix.'file'],
Chris@0:             'line' => $a[$sPrefix.'line'],
Chris@17:         ]];
Chris@0: 
Chris@0:         if (isset($a[$sPrefix.'trace'])) {
Chris@0:             $trace = array_merge($trace, $a[$sPrefix.'trace']);
Chris@0:         }
Chris@0: 
Chris@0:         unset($a[$sPrefix.'file'], $a[$sPrefix.'line'], $a[$sPrefix.'trace']);
Chris@0:         $a[Caster::PREFIX_VIRTUAL.'trace'] = new TraceStub($trace, self::$traceArgs);
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: 
Chris@0:     public static function castTraceStub(TraceStub $trace, array $a, Stub $stub, $isNested)
Chris@0:     {
Chris@0:         if (!$isNested) {
Chris@0:             return $a;
Chris@0:         }
Chris@0:         $stub->class = '';
Chris@0:         $stub->handle = 0;
Chris@0:         $frames = $trace->value;
Chris@0:         $prefix = Caster::PREFIX_VIRTUAL;
Chris@0: 
Chris@17:         $a = [];
Chris@17:         $j = \count($frames);
Chris@0:         if (0 > $i = $trace->sliceOffset) {
Chris@0:             $i = max(0, $j + $i);
Chris@0:         }
Chris@0:         if (!isset($trace->value[$i])) {
Chris@17:             return [];
Chris@0:         }
Chris@0:         $lastCall = isset($frames[$i]['function']) ? (isset($frames[$i]['class']) ? $frames[0]['class'].$frames[$i]['type'] : '').$frames[$i]['function'].'()' : '';
Chris@17:         $frames[] = ['function' => ''];
Chris@12:         $collapse = false;
Chris@0: 
Chris@0:         for ($j += $trace->numberingOffset - $i++; isset($frames[$i]); ++$i, --$j) {
Chris@0:             $f = $frames[$i];
Chris@0:             $call = isset($f['function']) ? (isset($f['class']) ? $f['class'].$f['type'] : '').$f['function'] : '???';
Chris@0: 
Chris@0:             $frame = new FrameStub(
Chris@17:                 [
Chris@0:                     'object' => isset($f['object']) ? $f['object'] : null,
Chris@0:                     'class' => isset($f['class']) ? $f['class'] : null,
Chris@0:                     'type' => isset($f['type']) ? $f['type'] : null,
Chris@0:                     'function' => isset($f['function']) ? $f['function'] : null,
Chris@17:                 ] + $frames[$i - 1],
Chris@0:                 false,
Chris@0:                 true
Chris@0:             );
Chris@17:             $f = self::castFrameStub($frame, [], $frame, true);
Chris@0:             if (isset($f[$prefix.'src'])) {
Chris@0:                 foreach ($f[$prefix.'src']->value as $label => $frame) {
Chris@12:                     if (0 === strpos($label, "\0~collapse=0")) {
Chris@12:                         if ($collapse) {
Chris@12:                             $label = substr_replace($label, '1', 11, 1);
Chris@12:                         } else {
Chris@12:                             $collapse = true;
Chris@12:                         }
Chris@12:                     }
Chris@0:                     $label = substr_replace($label, "title=Stack level $j.&", 2, 0);
Chris@0:                 }
Chris@0:                 $f = $frames[$i - 1];
Chris@0:                 if ($trace->keepArgs && !empty($f['args']) && $frame instanceof EnumStub) {
Chris@0:                     $frame->value['arguments'] = new ArgsStub($f['args'], isset($f['function']) ? $f['function'] : null, isset($f['class']) ? $f['class'] : null);
Chris@0:                 }
Chris@0:             } elseif ('???' !== $lastCall) {
Chris@0:                 $label = new ClassStub($lastCall);
Chris@0:                 if (isset($label->attr['ellipsis'])) {
Chris@0:                     $label->attr['ellipsis'] += 2;
Chris@0:                     $label = substr_replace($prefix, "ellipsis-type=class&ellipsis={$label->attr['ellipsis']}&ellipsis-tail=1&title=Stack level $j.", 2, 0).$label->value.'()';
Chris@0:                 } else {
Chris@0:                     $label = substr_replace($prefix, "title=Stack level $j.", 2, 0).$label->value.'()';
Chris@0:                 }
Chris@0:             } else {
Chris@0:                 $label = substr_replace($prefix, "title=Stack level $j.", 2, 0).$lastCall;
Chris@0:             }
Chris@12:             $a[substr_replace($label, sprintf('separator=%s&', $frame instanceof EnumStub ? ' ' : ':'), 2, 0)] = $frame;
Chris@0: 
Chris@0:             $lastCall = $call;
Chris@0:         }
Chris@0:         if (null !== $trace->sliceLength) {
Chris@17:             $a = \array_slice($a, 0, $trace->sliceLength, true);
Chris@0:         }
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: 
Chris@0:     public static function castFrameStub(FrameStub $frame, array $a, Stub $stub, $isNested)
Chris@0:     {
Chris@0:         if (!$isNested) {
Chris@0:             return $a;
Chris@0:         }
Chris@0:         $f = $frame->value;
Chris@0:         $prefix = Caster::PREFIX_VIRTUAL;
Chris@0: 
Chris@0:         if (isset($f['file'], $f['line'])) {
Chris@0:             $cacheKey = $f;
Chris@0:             unset($cacheKey['object'], $cacheKey['args']);
Chris@0:             $cacheKey[] = self::$srcContext;
Chris@0:             $cacheKey = implode('-', $cacheKey);
Chris@0: 
Chris@0:             if (isset(self::$framesCache[$cacheKey])) {
Chris@0:                 $a[$prefix.'src'] = self::$framesCache[$cacheKey];
Chris@0:             } else {
Chris@0:                 if (preg_match('/\((\d+)\)(?:\([\da-f]{32}\))? : (?:eval\(\)\'d code|runtime-created function)$/', $f['file'], $match)) {
Chris@17:                     $f['file'] = substr($f['file'], 0, -\strlen($match[0]));
Chris@0:                     $f['line'] = (int) $match[1];
Chris@0:                 }
Chris@0:                 $caller = isset($f['function']) ? sprintf('in %s() on line %d', (isset($f['class']) ? $f['class'].$f['type'] : '').$f['function'], $f['line']) : null;
Chris@0:                 $src = $f['line'];
Chris@0:                 $srcKey = $f['file'];
Chris@12:                 $ellipsis = new LinkStub($srcKey, 0);
Chris@12:                 $srcAttr = 'collapse='.(int) $ellipsis->inVendor;
Chris@12:                 $ellipsisTail = isset($ellipsis->attr['ellipsis-tail']) ? $ellipsis->attr['ellipsis-tail'] : 0;
Chris@12:                 $ellipsis = isset($ellipsis->attr['ellipsis']) ? $ellipsis->attr['ellipsis'] : 0;
Chris@0: 
Chris@0:                 if (file_exists($f['file']) && 0 <= self::$srcContext) {
Chris@0:                     if (!empty($f['class']) && (is_subclass_of($f['class'], 'Twig\Template') || is_subclass_of($f['class'], 'Twig_Template')) && method_exists($f['class'], 'getDebugInfo')) {
Chris@17:                         $template = isset($f['object']) ? $f['object'] : unserialize(sprintf('O:%d:"%s":0:{}', \strlen($f['class']), $f['class']));
Chris@0: 
Chris@0:                         $ellipsis = 0;
Chris@0:                         $templateSrc = method_exists($template, 'getSourceContext') ? $template->getSourceContext()->getCode() : (method_exists($template, 'getSource') ? $template->getSource() : '');
Chris@0:                         $templateInfo = $template->getDebugInfo();
Chris@0:                         if (isset($templateInfo[$f['line']])) {
Chris@0:                             if (!method_exists($template, 'getSourceContext') || !file_exists($templatePath = $template->getSourceContext()->getPath())) {
Chris@0:                                 $templatePath = null;
Chris@0:                             }
Chris@0:                             if ($templateSrc) {
Chris@0:                                 $src = self::extractSource($templateSrc, $templateInfo[$f['line']], self::$srcContext, $caller, 'twig', $templatePath);
Chris@0:                                 $srcKey = ($templatePath ?: $template->getTemplateName()).':'.$templateInfo[$f['line']];
Chris@0:                             }
Chris@0:                         }
Chris@0:                     }
Chris@0:                     if ($srcKey == $f['file']) {
Chris@0:                         $src = self::extractSource(file_get_contents($f['file']), $f['line'], self::$srcContext, $caller, 'php', $f['file']);
Chris@0:                         $srcKey .= ':'.$f['line'];
Chris@0:                         if ($ellipsis) {
Chris@17:                             $ellipsis += 1 + \strlen($f['line']);
Chris@0:                         }
Chris@0:                     }
Chris@12:                     $srcAttr .= '&separator= ';
Chris@12:                 } else {
Chris@12:                     $srcAttr .= '&separator=:';
Chris@0:                 }
Chris@12:                 $srcAttr .= $ellipsis ? '&ellipsis-type=path&ellipsis='.$ellipsis.'&ellipsis-tail='.$ellipsisTail : '';
Chris@17:                 self::$framesCache[$cacheKey] = $a[$prefix.'src'] = new EnumStub(["\0~$srcAttr\0$srcKey" => $src]);
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         unset($a[$prefix.'args'], $a[$prefix.'line'], $a[$prefix.'file']);
Chris@0:         if ($frame->inTraceStub) {
Chris@0:             unset($a[$prefix.'class'], $a[$prefix.'type'], $a[$prefix.'function']);
Chris@0:         }
Chris@0:         foreach ($a as $k => $v) {
Chris@0:             if (!$v) {
Chris@0:                 unset($a[$k]);
Chris@0:             }
Chris@0:         }
Chris@0:         if ($frame->keepArgs && !empty($f['args'])) {
Chris@0:             $a[$prefix.'arguments'] = new ArgsStub($f['args'], $f['function'], $f['class']);
Chris@0:         }
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: 
Chris@0:     private static function filterExceptionArray($xClass, array $a, $xPrefix, $filter)
Chris@0:     {
Chris@0:         if (isset($a[$xPrefix.'trace'])) {
Chris@0:             $trace = $a[$xPrefix.'trace'];
Chris@0:             unset($a[$xPrefix.'trace']); // Ensures the trace is always last
Chris@0:         } else {
Chris@17:             $trace = [];
Chris@0:         }
Chris@0: 
Chris@0:         if (!($filter & Caster::EXCLUDE_VERBOSE) && $trace) {
Chris@0:             if (isset($a[Caster::PREFIX_PROTECTED.'file'], $a[Caster::PREFIX_PROTECTED.'line'])) {
Chris@0:                 self::traceUnshift($trace, $xClass, $a[Caster::PREFIX_PROTECTED.'file'], $a[Caster::PREFIX_PROTECTED.'line']);
Chris@0:             }
Chris@0:             $a[Caster::PREFIX_VIRTUAL.'trace'] = new TraceStub($trace, self::$traceArgs);
Chris@0:         }
Chris@0:         if (empty($a[$xPrefix.'previous'])) {
Chris@0:             unset($a[$xPrefix.'previous']);
Chris@0:         }
Chris@0:         unset($a[$xPrefix.'string'], $a[Caster::PREFIX_DYNAMIC.'xdebug_message'], $a[Caster::PREFIX_DYNAMIC.'__destructorException']);
Chris@0: 
Chris@0:         if (isset($a[Caster::PREFIX_PROTECTED.'file'], $a[Caster::PREFIX_PROTECTED.'line'])) {
Chris@0:             $a[Caster::PREFIX_PROTECTED.'file'] = new LinkStub($a[Caster::PREFIX_PROTECTED.'file'], $a[Caster::PREFIX_PROTECTED.'line']);
Chris@0:         }
Chris@0: 
Chris@0:         return $a;
Chris@0:     }
Chris@0: 
Chris@0:     private static function traceUnshift(&$trace, $class, $file, $line)
Chris@0:     {
Chris@0:         if (isset($trace[0]['file'], $trace[0]['line']) && $trace[0]['file'] === $file && $trace[0]['line'] === $line) {
Chris@0:             return;
Chris@0:         }
Chris@17:         array_unshift($trace, [
Chris@0:             'function' => $class ? 'new '.$class : null,
Chris@0:             'file' => $file,
Chris@0:             'line' => $line,
Chris@17:         ]);
Chris@0:     }
Chris@0: 
Chris@0:     private static function extractSource($srcLines, $line, $srcContext, $title, $lang, $file = null)
Chris@0:     {
Chris@0:         $srcLines = explode("\n", $srcLines);
Chris@17:         $src = [];
Chris@0: 
Chris@0:         for ($i = $line - 1 - $srcContext; $i <= $line - 1 + $srcContext; ++$i) {
Chris@0:             $src[] = (isset($srcLines[$i]) ? $srcLines[$i] : '')."\n";
Chris@0:         }
Chris@0: 
Chris@17:         $srcLines = [];
Chris@0:         $ltrim = 0;
Chris@0:         do {
Chris@0:             $pad = null;
Chris@0:             for ($i = $srcContext << 1; $i >= 0; --$i) {
Chris@0:                 if (isset($src[$i][$ltrim]) && "\r" !== ($c = $src[$i][$ltrim]) && "\n" !== $c) {
Chris@0:                     if (null === $pad) {
Chris@0:                         $pad = $c;
Chris@0:                     }
Chris@0:                     if ((' ' !== $c && "\t" !== $c) || $pad !== $c) {
Chris@0:                         break;
Chris@0:                     }
Chris@0:                 }
Chris@0:             }
Chris@0:             ++$ltrim;
Chris@0:         } while (0 > $i && null !== $pad);
Chris@0: 
Chris@0:         --$ltrim;
Chris@0: 
Chris@0:         foreach ($src as $i => $c) {
Chris@0:             if ($ltrim) {
Chris@0:                 $c = isset($c[$ltrim]) && "\r" !== $c[$ltrim] ? substr($c, $ltrim) : ltrim($c, " \t");
Chris@0:             }
Chris@0:             $c = substr($c, 0, -1);
Chris@0:             if ($i !== $srcContext) {
Chris@0:                 $c = new ConstStub('default', $c);
Chris@0:             } else {
Chris@0:                 $c = new ConstStub($c, $title);
Chris@0:                 if (null !== $file) {
Chris@0:                     $c->attr['file'] = $file;
Chris@0:                     $c->attr['line'] = $line;
Chris@0:                 }
Chris@0:             }
Chris@0:             $c->attr['lang'] = $lang;
Chris@12:             $srcLines[sprintf("\0~separator=› &%d\0", $i + $line - $srcContext)] = $c;
Chris@0:         }
Chris@0: 
Chris@0:         return new EnumStub($srcLines);
Chris@0:     }
Chris@0: }