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