annotate vendor/symfony/var-dumper/Caster/ExceptionCaster.php @ 19:fa3358dc1485 tip

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