vendor/se7enxweb/symfony-error-handler/ErrorHandler.php line 409

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\ErrorHandler;
  14. use Psr\Log\LoggerInterface;
  15. use Psr\Log\LogLevel;
  16. use Symfony\Component\ErrorHandler\Error\FatalError;
  17. use Symfony\Component\ErrorHandler\Error\OutOfMemoryError;
  18. use Symfony\Component\ErrorHandler\ErrorEnhancer\ClassNotFoundErrorEnhancer;
  19. use Symfony\Component\ErrorHandler\ErrorEnhancer\ErrorEnhancerInterface;
  20. use Symfony\Component\ErrorHandler\ErrorEnhancer\UndefinedFunctionErrorEnhancer;
  21. use Symfony\Component\ErrorHandler\ErrorEnhancer\UndefinedMethodErrorEnhancer;
  22. use Symfony\Component\ErrorHandler\ErrorRenderer\CliErrorRenderer;
  23. use Symfony\Component\ErrorHandler\ErrorRenderer\HtmlErrorRenderer;
  24. use Symfony\Component\ErrorHandler\Exception\SilencedErrorContext;
  26. /**
  27. * A generic ErrorHandler for the PHP engine.
  28. *
  29. * Provides five bit fields that control how errors are handled:
  30. * - thrownErrors: errors thrown as \ErrorException
  31. * - loggedErrors: logged errors, when not @-silenced
  32. * - scopedErrors: errors thrown or logged with their local context
  33. * - tracedErrors: errors logged with their stack trace
  34. * - screamedErrors: never @-silenced errors
  35. *
  36. * Each error level can be logged by a dedicated PSR-3 logger object.
  37. * Screaming only applies to logging.
  38. * Throwing takes precedence over logging.
  39. * Uncaught exceptions are logged as E_ERROR.
  40. * E_DEPRECATED and E_USER_DEPRECATED levels never throw.
  41. * E_RECOVERABLE_ERROR and E_USER_ERROR levels always throw.
  42. * Non catchable errors that can be detected at shutdown time are logged when the scream bit field allows so.
  43. * As errors have a performance cost, repeated errors are all logged, so that the developer
  44. * can see them and weight them as more important to fix than others of the same level.
  45. *
  46. * @author Nicolas Grekas <p@tchwork.com>
  47. * @author Grégoire Pineau <lyrixx@lyrixx.info>
  48. *
  49. * @final
  50. */
  51. class ErrorHandler
  52. {
  53. private $levels = [
  54. \E_DEPRECATED => 'Deprecated',
  55. \E_USER_DEPRECATED => 'User Deprecated',
  56. \E_NOTICE => 'Notice',
  57. \E_USER_NOTICE => 'User Notice',
  58. \E_WARNING => 'Warning',
  59. \E_USER_WARNING => 'User Warning',
  60. \E_COMPILE_WARNING => 'Compile Warning',
  61. \E_CORE_WARNING => 'Core Warning',
  62. \E_USER_ERROR => 'User Error',
  63. \E_RECOVERABLE_ERROR => 'Catchable Fatal Error',
  64. \E_COMPILE_ERROR => 'Compile Error',
  65. \E_PARSE => 'Parse Error',
  66. \E_ERROR => 'Error',
  67. \E_CORE_ERROR => 'Core Error',
  68. ];
  70. private $loggers = [
  71. \E_DEPRECATED => [null, LogLevel::INFO],
  72. \E_USER_DEPRECATED => [null, LogLevel::INFO],
  73. \E_NOTICE => [null, LogLevel::WARNING],
  74. \E_USER_NOTICE => [null, LogLevel::WARNING],
  75. \E_WARNING => [null, LogLevel::WARNING],
  76. \E_USER_WARNING => [null, LogLevel::WARNING],
  77. \E_COMPILE_WARNING => [null, LogLevel::WARNING],
  78. \E_CORE_WARNING => [null, LogLevel::WARNING],
  79. \E_USER_ERROR => [null, LogLevel::CRITICAL],
  80. \E_RECOVERABLE_ERROR => [null, LogLevel::CRITICAL],
  81. \E_COMPILE_ERROR => [null, LogLevel::CRITICAL],
  82. \E_PARSE => [null, LogLevel::CRITICAL],
  83. \E_ERROR => [null, LogLevel::CRITICAL],
  84. \E_CORE_ERROR => [null, LogLevel::CRITICAL],
  85. ];
  87. private $thrownErrors = 0x1FFF; // E_ALL - E_DEPRECATED - E_USER_DEPRECATED
  88. private $scopedErrors = 0x1FFF; // E_ALL - E_DEPRECATED - E_USER_DEPRECATED
  89. private $tracedErrors = 0x77FB; // E_ALL - E_STRICT - E_PARSE
  90. private $screamedErrors = 0x55; // E_ERROR + E_CORE_ERROR + E_COMPILE_ERROR + E_PARSE
  91. private $loggedErrors = 0;
  92. private $configureException;
  93. private $debug;
  95. private $isRecursive = 0;
  96. private $isRoot = false;
  97. private $exceptionHandler;
  98. private $bootstrappingLogger;
  100. private static $reservedMemory;
  101. private static $toStringException;
  102. private static $silencedErrorCache = [];
  103. private static $silencedErrorCount = 0;
  104. private static $exitCode = 0;
  106. /**
  107. * Registers the error handler.
  108. */
  109. public static function register(?self $handler = null, bool $replace = true): self
  110. {
  111. if (null === self::$reservedMemory) {
  112. self::$reservedMemory = str_repeat('x', 32768);
  113. register_shutdown_function(__CLASS__.'::handleFatalError');
  114. }
  116. if ($handlerIsNew = null === $handler) {
  117. $handler = new static();
  118. }
  120. if (null === $prev = set_error_handler([$handler, 'handleError'])) {
  121. restore_error_handler();
  122. // Specifying the error types earlier would expose us to https://bugs.php.net/63206
  123. set_error_handler([$handler, 'handleError'], $handler->thrownErrors | $handler->loggedErrors);
  124. $handler->isRoot = true;
  125. }
  127. if ($handlerIsNew && \is_array($prev) && $prev[0] instanceof self) {
  128. $handler = $prev[0];
  129. $replace = false;
  130. }
  131. if (!$replace && $prev) {
  132. restore_error_handler();
  133. $handlerIsRegistered = \is_array($prev) && $handler === $prev[0];
  134. } else {
  135. $handlerIsRegistered = true;
  136. }
  137. if (\is_array($prev = set_exception_handler([$handler, 'handleException'])) && $prev[0] instanceof self) {
  138. restore_exception_handler();
  139. if (!$handlerIsRegistered) {
  140. $handler = $prev[0];
  141. } elseif ($handler !== $prev[0] && $replace) {
  142. set_exception_handler([$handler, 'handleException']);
  143. $p = $prev[0]->setExceptionHandler(null);
  144. $handler->setExceptionHandler($p);
  145. $prev[0]->setExceptionHandler($p);
  146. }
  147. } else {
  148. $handler->setExceptionHandler($prev ?? [$handler, 'renderException']);
  149. }
  151. $handler->throwAt(\E_ALL & $handler->thrownErrors, true);
  153. return $handler;
  154. }
  156. /**
  157. * Calls a function and turns any PHP error into \ErrorException.
  158. *
  159. * @return mixed What $function(...$arguments) returns
  160. *
  161. * @throws \ErrorException When $function(...$arguments) triggers a PHP error
  162. */
  163. public static function call(callable $function, ...$arguments)
  164. {
  165. set_error_handler(static function (int $type, string $message, string $file, int $line) {
  166. if (__FILE__ === $file) {
  167. $trace = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 3);
  168. $file = $trace[2]['file'] ?? $file;
  169. $line = $trace[2]['line'] ?? $line;
  170. }
  172. throw new \ErrorException($message, 0, $type, $file, $line);
  173. });
  175. try {
  176. return $function(...$arguments);
  177. } finally {
  178. restore_error_handler();
  179. }
  180. }
  182. public function __construct(?BufferingLogger $bootstrappingLogger = null, bool $debug = false)
  183. {
  184. if (\PHP_VERSION_ID < 80400) {
  185. $this->levels[\E_STRICT] = 'Runtime Notice';
  186. $this->loggers[\E_STRICT] = [null, LogLevel::WARNING];
  187. }
  189. if ($bootstrappingLogger) {
  190. $this->bootstrappingLogger = $bootstrappingLogger;
  191. $this->setDefaultLogger($bootstrappingLogger);
  192. }
  193. $traceReflector = new \ReflectionProperty(\Exception::class, 'trace');
  194. $this->configureException = \Closure::bind(static function ($e, $trace, $file = null, $line = null) use ($traceReflector) {
  195. $traceReflector->setValue($e, $trace);
  196. $e->file = $file ?? $e->file;
  197. $e->line = $line ?? $e->line;
  198. }, null, new class() extends \Exception {
  199. });
  200. $this->debug = $debug;
  201. }
  203. /**
  204. * Sets a logger to non assigned errors levels.
  205. *
  206. * @param LoggerInterface $logger A PSR-3 logger to put as default for the given levels
  207. * @param array|int|null $levels An array map of E_* to LogLevel::* or an integer bit field of E_* constants
  208. * @param bool $replace Whether to replace or not any existing logger
  209. */
  210. public function setDefaultLogger(LoggerInterface $logger, $levels = \E_ALL, bool $replace = false): void
  211. {
  212. $loggers = [];
  214. if (\is_array($levels)) {
  215. foreach ($levels as $type => $logLevel) {
  216. if (empty($this->loggers[$type][0]) || $replace || $this->loggers[$type][0] === $this->bootstrappingLogger) {
  217. $loggers[$type] = [$logger, $logLevel];
  218. }
  219. }
  220. } else {
  221. if (null === $levels) {
  222. $levels = \E_ALL;
  223. }
  224. foreach ($this->loggers as $type => $log) {
  225. if (($type & $levels) && (empty($log[0]) || $replace || $log[0] === $this->bootstrappingLogger)) {
  226. $log[0] = $logger;
  227. $loggers[$type] = $log;
  228. }
  229. }
  230. }
  232. $this->setLoggers($loggers);
  233. }
  235. /**
  236. * Sets a logger for each error level.
  237. *
  238. * @param array $loggers Error levels to [LoggerInterface|null, LogLevel::*] map
  239. *
  240. * @return array The previous map
  241. *
  242. * @throws \InvalidArgumentException
  243. */
  244. public function setLoggers(array $loggers): array
  245. {
  246. $prevLogged = $this->loggedErrors;
  247. $prev = $this->loggers;
  248. $flush = [];
  250. foreach ($loggers as $type => $log) {
  251. if (!isset($prev[$type])) {
  252. throw new \InvalidArgumentException('Unknown error type: '.$type);
  253. }
  254. if (!\is_array($log)) {
  255. $log = [$log];
  256. } elseif (!\array_key_exists(0, $log)) {
  257. throw new \InvalidArgumentException('No logger provided.');
  258. }
  259. if (null === $log[0]) {
  260. $this->loggedErrors &= ~$type;
  261. } elseif ($log[0] instanceof LoggerInterface) {
  262. $this->loggedErrors |= $type;
  263. } else {
  264. throw new \InvalidArgumentException('Invalid logger provided.');
  265. }
  266. $this->loggers[$type] = $log + $prev[$type];
  268. if ($this->bootstrappingLogger && $prev[$type][0] === $this->bootstrappingLogger) {
  269. $flush[$type] = $type;
  270. }
  271. }
  272. $this->reRegister($prevLogged | $this->thrownErrors);
  274. if ($flush) {
  275. foreach ($this->bootstrappingLogger->cleanLogs() as $log) {
  276. $type = ThrowableUtils::getSeverity($log[2]['exception']);
  277. if (!isset($flush[$type])) {
  278. $this->bootstrappingLogger->log($log[0], $log[1], $log[2]);
  279. } elseif ($this->loggers[$type][0]) {
  280. $this->loggers[$type][0]->log($this->loggers[$type][1], $log[1], $log[2]);
  281. }
  282. }
  283. }
  285. return $prev;
  286. }
  288. /**
  289. * Sets a user exception handler.
  290. *
  291. * @param callable(\Throwable $e)|null $handler
  292. *
  293. * @return callable|null The previous exception handler
  294. */
  295. public function setExceptionHandler(?callable $handler): ?callable
  296. {
  297. $prev = $this->exceptionHandler;
  298. $this->exceptionHandler = $handler;
  300. return $prev;
  301. }
  303. /**
  304. * Sets the PHP error levels that throw an exception when a PHP error occurs.
  305. *
  306. * @param int $levels A bit field of E_* constants for thrown errors
  307. * @param bool $replace Replace or amend the previous value
  308. *
  309. * @return int The previous value
  310. */
  311. public function throwAt(int $levels, bool $replace = false): int
  312. {
  313. $prev = $this->thrownErrors;
  314. $this->thrownErrors = ($levels | \E_RECOVERABLE_ERROR | \E_USER_ERROR) & ~\E_USER_DEPRECATED & ~\E_DEPRECATED;
  315. if (!$replace) {
  316. $this->thrownErrors |= $prev;
  317. }
  318. $this->reRegister($prev | $this->loggedErrors);
  320. return $prev;
  321. }
  323. /**
  324. * Sets the PHP error levels for which local variables are preserved.
  325. *
  326. * @param int $levels A bit field of E_* constants for scoped errors
  327. * @param bool $replace Replace or amend the previous value
  328. *
  329. * @return int The previous value
  330. */
  331. public function scopeAt(int $levels, bool $replace = false): int
  332. {
  333. $prev = $this->scopedErrors;
  334. $this->scopedErrors = $levels;
  335. if (!$replace) {
  336. $this->scopedErrors |= $prev;
  337. }
  339. return $prev;
  340. }
  342. /**
  343. * Sets the PHP error levels for which the stack trace is preserved.
  344. *
  345. * @param int $levels A bit field of E_* constants for traced errors
  346. * @param bool $replace Replace or amend the previous value
  347. *
  348. * @return int The previous value
  349. */
  350. public function traceAt(int $levels, bool $replace = false): int
  351. {
  352. $prev = $this->tracedErrors;
  353. $this->tracedErrors = $levels;
  354. if (!$replace) {
  355. $this->tracedErrors |= $prev;
  356. }
  358. return $prev;
  359. }
  361. /**
  362. * Sets the error levels where the @-operator is ignored.
  363. *
  364. * @param int $levels A bit field of E_* constants for screamed errors
  365. * @param bool $replace Replace or amend the previous value
  366. *
  367. * @return int The previous value
  368. */
  369. public function screamAt(int $levels, bool $replace = false): int
  370. {
  371. $prev = $this->screamedErrors;
  372. $this->screamedErrors = $levels;
  373. if (!$replace) {
  374. $this->screamedErrors |= $prev;
  375. }
  377. return $prev;
  378. }
  380. /**
  381. * Re-registers as a PHP error handler if levels changed.
  382. */
  383. private function reRegister(int $prev): void
  384. {
  385. if ($prev !== ($this->thrownErrors | $this->loggedErrors)) {
  386. $handler = set_error_handler('is_int');
  387. $handler = \is_array($handler) ? $handler[0] : null;
  388. restore_error_handler();
  389. if ($handler === $this) {
  390. restore_error_handler();
  391. if ($this->isRoot) {
  392. set_error_handler([$this, 'handleError'], $this->thrownErrors | $this->loggedErrors);
  393. } else {
  394. set_error_handler([$this, 'handleError']);
  395. }
  396. }
  397. }
  398. }
  400. /**
  401. * Handles errors by filtering then logging them according to the configured bit fields.
  402. *
  403. * @return bool Returns false when no handling happens so that the PHP engine can handle the error itself
  404. *
  405. * @throws \ErrorException When $this->thrownErrors requests so
  406. *
  407. * @internal
  408. */
  409. public function handleError(int $type, string $message, string $file, int $line): bool
  410. {
  411. if (\PHP_VERSION_ID >= 70300 && \E_WARNING === $type && '"' === $message[0] && false !== strpos($message, '" targeting switch is equivalent to "break')) {
  412. $type = \E_DEPRECATED;
  413. }
  415. // Level is the current error reporting level to manage silent error.
  416. $level = error_reporting();
  417. $silenced = 0 === ($level & $type);
  418. // Strong errors are not authorized to be silenced.
  419. $level |= \E_RECOVERABLE_ERROR | \E_USER_ERROR | \E_DEPRECATED | \E_USER_DEPRECATED;
  420. $log = $this->loggedErrors & $type;
  421. $throw = $this->thrownErrors & $type & $level;
  422. $type &= $level | $this->screamedErrors;
  424. // Never throw on warnings triggered by assert()
  425. if (\E_WARNING === $type && 'a' === $message[0] && 0 === strncmp($message, 'assert(): ', 10)) {
  426. $throw = 0;
  427. }
  429. if (!$type || (!$log && !$throw)) {
  430. return false;
  431. }
  433. $logMessage = $this->levels[$type].': '.$message;
  435. if (null !== self::$toStringException) {
  436. $errorAsException = self::$toStringException;
  437. self::$toStringException = null;
  438. } elseif (!$throw && !($type & $level)) {
  439. if (!isset(self::$silencedErrorCache[$id = $file.':'.$line])) {
  440. $lightTrace = $this->tracedErrors & $type ? $this->cleanTrace(debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 5), $type, $file, $line, false) : [];
  441. $errorAsException = new SilencedErrorContext($type, $file, $line, isset($lightTrace[1]) ? [$lightTrace[0]] : $lightTrace);
  442. } elseif (isset(self::$silencedErrorCache[$id][$message])) {
  443. $lightTrace = null;
  444. $errorAsException = self::$silencedErrorCache[$id][$message];
  445. ++$errorAsException->count;
  446. } else {
  447. $lightTrace = [];
  448. $errorAsException = null;
  449. }
  451. if (100 < ++self::$silencedErrorCount) {
  452. self::$silencedErrorCache = $lightTrace = [];
  453. self::$silencedErrorCount = 1;
  454. }
  455. if ($errorAsException) {
  456. self::$silencedErrorCache[$id][$message] = $errorAsException;
  457. }
  458. if (null === $lightTrace) {
  459. return true;
  460. }
  461. } else {
  462. if (PHP_VERSION_ID < 80303 && false !== strpos($message, '@anonymous')) {
  463. $backtrace = debug_backtrace(false, 5);
  465. for ($i = 1; isset($backtrace[$i]); ++$i) {
  466. if (isset($backtrace[$i]['function'], $backtrace[$i]['args'][0])
  467. && ('trigger_error' === $backtrace[$i]['function'] || 'user_error' === $backtrace[$i]['function'])
  468. ) {
  469. if ($backtrace[$i]['args'][0] !== $message) {
  470. $message = $backtrace[$i]['args'][0];
  471. }
  473. break;
  474. }
  475. }
  476. }
  478. if (false !== strpos($message, "@anonymous\0")) {
  479. $message = $this->parseAnonymousClass($message);
  480. $logMessage = $this->levels[$type].': '.$message;
  481. }
  483. $errorAsException = new \ErrorException($logMessage, 0, $type, $file, $line);
  485. if ($throw || $this->tracedErrors & $type) {
  486. $backtrace = $errorAsException->getTrace();
  487. $lightTrace = $this->cleanTrace($backtrace, $type, $file, $line, $throw);
  488. ($this->configureException)($errorAsException, $lightTrace, $file, $line);
  489. } else {
  490. ($this->configureException)($errorAsException, []);
  491. $backtrace = [];
  492. }
  493. }
  495. if ($throw) {
  496. if (\PHP_VERSION_ID < 70400 && \E_USER_ERROR & $type) {
  497. for ($i = 1; isset($backtrace[$i]); ++$i) {
  498. if (isset($backtrace[$i]['function'], $backtrace[$i]['type'], $backtrace[$i - 1]['function'])
  499. && '__toString' === $backtrace[$i]['function']
  500. && '->' === $backtrace[$i]['type']
  501. && !isset($backtrace[$i - 1]['class'])
  502. && ('trigger_error' === $backtrace[$i - 1]['function'] || 'user_error' === $backtrace[$i - 1]['function'])
  503. ) {
  504. // Here, we know trigger_error() has been called from __toString().
  505. // PHP triggers a fatal error when throwing from __toString().
  506. // A small convention allows working around the limitation:
  507. // given a caught $e exception in __toString(), quitting the method with
  508. // `return trigger_error($e, E_USER_ERROR);` allows this error handler
  509. // to make $e get through the __toString() barrier.
  511. $context = 4 < \func_num_args() ? (func_get_arg(4) ?: []) : [];
  513. foreach ($context as $e) {
  514. if ($e instanceof \Throwable && $e->__toString() === $message) {
  515. self::$toStringException = $e;
  517. return true;
  518. }
  519. }
  521. // Display the original error message instead of the default one.
  522. $exitCode = self::$exitCode;
  523. try {
  524. $this->handleException($errorAsException);
  525. } finally {
  526. self::$exitCode = $exitCode;
  527. }
  529. // Stop the process by giving back the error to the native handler.
  530. return false;
  531. }
  532. }
  533. }
  535. throw $errorAsException;
  536. }
  538. if ($this->isRecursive) {
  539. $log = 0;
  540. } else {
  541. if (\PHP_VERSION_ID < (\PHP_VERSION_ID < 70400 ? 70316 : 70404)) {
  542. $currentErrorHandler = set_error_handler('is_int');
  543. restore_error_handler();
  544. }
  546. try {
  547. $this->isRecursive = true;
  548. $level = ($type & $level) ? $this->loggers[$type][1] : LogLevel::DEBUG;
  549. $this->loggers[$type][0]->log($level, $logMessage, $errorAsException ? ['exception' => $errorAsException] : []);
  550. } finally {
  551. $this->isRecursive = false;
  553. if (\PHP_VERSION_ID < (\PHP_VERSION_ID < 70400 ? 70316 : 70404)) {
  554. set_error_handler($currentErrorHandler);
  555. }
  556. }
  557. }
  559. return !$silenced && $type && $log;
  560. }
  562. /**
  563. * Handles an exception by logging then forwarding it to another handler.
  564. *
  565. * @internal
  566. */
  567. public function handleException(\Throwable $exception)
  568. {
  569. $handlerException = null;
  571. if (!$exception instanceof FatalError) {
  572. self::$exitCode = 255;
  574. $type = ThrowableUtils::getSeverity($exception);
  575. } else {
  576. $type = $exception->getError()['type'];
  577. }
  579. if ($this->loggedErrors & $type) {
  580. if (false !== strpos($message = $exception->getMessage(), "@anonymous\0")) {
  581. $message = $this->parseAnonymousClass($message);
  582. }
  584. if ($exception instanceof FatalError) {
  585. $message = 'Fatal '.$message;
  586. } elseif ($exception instanceof \Error) {
  587. $message = 'Uncaught Error: '.$message;
  588. } elseif ($exception instanceof \ErrorException) {
  589. $message = 'Uncaught '.$message;
  590. } else {
  591. $message = 'Uncaught Exception: '.$message;
  592. }
  594. try {
  595. $this->loggers[$type][0]->log($this->loggers[$type][1], $message, ['exception' => $exception]);
  596. } catch (\Throwable $handlerException) {
  597. }
  598. }
  600. if (!$exception instanceof OutOfMemoryError) {
  601. foreach ($this->getErrorEnhancers() as $errorEnhancer) {
  602. if ($e = $errorEnhancer->enhance($exception)) {
  603. $exception = $e;
  604. break;
  605. }
  606. }
  607. }
  609. $exceptionHandler = $this->exceptionHandler;
  610. $this->exceptionHandler = [$this, 'renderException'];
  612. if (null === $exceptionHandler || $exceptionHandler === $this->exceptionHandler) {
  613. $this->exceptionHandler = null;
  614. }
  616. try {
  617. if (null !== $exceptionHandler) {
  618. return $exceptionHandler($exception);
  619. }
  620. $handlerException = $handlerException ?: $exception;
  621. } catch (\Throwable $handlerException) {
  622. }
  623. if ($exception === $handlerException && null === $this->exceptionHandler) {
  624. self::$reservedMemory = null; // Disable the fatal error handler
  625. throw $exception; // Give back $exception to the native handler
  626. }
  628. $loggedErrors = $this->loggedErrors;
  629. if ($exception === $handlerException) {
  630. $this->loggedErrors &= ~$type;
  631. }
  633. try {
  634. $this->handleException($handlerException);
  635. } finally {
  636. $this->loggedErrors = $loggedErrors;
  637. }
  638. }
  640. /**
  641. * Shutdown registered function for handling PHP fatal errors.
  642. *
  643. * @param array|null $error An array as returned by error_get_last()
  644. *
  645. * @internal
  646. */
  647. public static function handleFatalError(?array $error = null): void
  648. {
  649. if (null === self::$reservedMemory) {
  650. return;
  651. }
  653. $handler = self::$reservedMemory = null;
  654. $handlers = [];
  655. $previousHandler = null;
  656. $sameHandlerLimit = 10;
  658. while (!\is_array($handler) || !$handler[0] instanceof self) {
  659. $handler = set_exception_handler('is_int');
  660. restore_exception_handler();
  662. if (!$handler) {
  663. break;
  664. }
  665. restore_exception_handler();
  667. if ($handler !== $previousHandler) {
  668. array_unshift($handlers, $handler);
  669. $previousHandler = $handler;
  670. } elseif (0 === --$sameHandlerLimit) {
  671. $handler = null;
  672. break;
  673. }
  674. }
  675. foreach ($handlers as $h) {
  676. set_exception_handler($h);
  677. }
  678. if (!$handler) {
  679. if (null === $error && $exitCode = self::$exitCode) {
  680. register_shutdown_function('register_shutdown_function', function () use ($exitCode) { exit($exitCode); });
  681. }
  683. return;
  684. }
  685. if ($handler !== $h) {
  686. $handler[0]->setExceptionHandler($h);
  687. }
  688. $handler = $handler[0];
  689. $handlers = [];
  691. if ($exit = null === $error) {
  692. $error = error_get_last();
  693. }
  695. if ($error && $error['type'] &= \E_PARSE | \E_ERROR | \E_CORE_ERROR | \E_COMPILE_ERROR) {
  696. // Let's not throw anymore but keep logging
  697. $handler->throwAt(0, true);
  698. $trace = $error['backtrace'] ?? null;
  700. if (0 === strpos($error['message'], 'Allowed memory') || 0 === strpos($error['message'], 'Out of memory')) {
  701. $fatalError = new OutOfMemoryError($handler->levels[$error['type']].': '.$error['message'], 0, $error, 2, false, $trace);
  702. } else {
  703. $fatalError = new FatalError($handler->levels[$error['type']].': '.$error['message'], 0, $error, 2, true, $trace);
  704. }
  705. } else {
  706. $fatalError = null;
  707. }
  709. try {
  710. if (null !== $fatalError) {
  711. self::$exitCode = 255;
  712. $handler->handleException($fatalError);
  713. }
  714. } catch (FatalError $e) {
  715. // Ignore this re-throw
  716. }
  718. if ($exit && $exitCode = self::$exitCode) {
  719. register_shutdown_function('register_shutdown_function', function () use ($exitCode) { exit($exitCode); });
  720. }
  721. }
  723. /**
  724. * Renders the given exception.
  725. *
  726. * As this method is mainly called during boot where nothing is yet available,
  727. * the output is always either HTML or CLI depending where PHP runs.
  728. */
  729. private function renderException(\Throwable $exception): void
  730. {
  731. $renderer = \in_array(\PHP_SAPI, ['cli', 'phpdbg'], true) ? new CliErrorRenderer() : new HtmlErrorRenderer($this->debug);
  733. $exception = $renderer->render($exception);
  735. if (!headers_sent()) {
  736. http_response_code($exception->getStatusCode());
  738. foreach ($exception->getHeaders() as $name => $value) {
  739. header($name.': '.$value, false);
  740. }
  741. }
  743. echo $exception->getAsString();
  744. }
  746. /**
  747. * Override this method if you want to define more error enhancers.
  748. *
  749. * @return ErrorEnhancerInterface[]
  750. */
  751. protected function getErrorEnhancers(): iterable
  752. {
  753. return [
  754. new UndefinedFunctionErrorEnhancer(),
  755. new UndefinedMethodErrorEnhancer(),
  756. new ClassNotFoundErrorEnhancer(),
  757. ];
  758. }
  760. /**
  761. * Cleans the trace by removing function arguments and the frames added by the error handler and DebugClassLoader.
  762. */
  763. private function cleanTrace(array $backtrace, int $type, string &$file, int &$line, bool $throw): array
  764. {
  765. $lightTrace = $backtrace;
  767. for ($i = 0; isset($backtrace[$i]); ++$i) {
  768. if (isset($backtrace[$i]['file'], $backtrace[$i]['line']) && $backtrace[$i]['line'] === $line && $backtrace[$i]['file'] === $file) {
  769. $lightTrace = \array_slice($lightTrace, 1 + $i);
  770. break;
  771. }
  772. }
  773. if (\E_USER_DEPRECATED === $type) {
  774. for ($i = 0; isset($lightTrace[$i]); ++$i) {
  775. if (!isset($lightTrace[$i]['file'], $lightTrace[$i]['line'], $lightTrace[$i]['function'])) {
  776. continue;
  777. }
  778. if (!isset($lightTrace[$i]['class']) && 'trigger_deprecation' === $lightTrace[$i]['function']) {
  779. $file = $lightTrace[$i]['file'];
  780. $line = $lightTrace[$i]['line'];
  781. $lightTrace = \array_slice($lightTrace, 1 + $i);
  782. break;
  783. }
  784. }
  785. }
  786. if (class_exists(DebugClassLoader::class, false)) {
  787. for ($i = \count($lightTrace) - 2; 0 < $i; --$i) {
  788. if (DebugClassLoader::class === ($lightTrace[$i]['class'] ?? null)) {
  789. array_splice($lightTrace, --$i, 2);
  790. }
  791. }
  792. }
  793. if (!($throw || $this->scopedErrors & $type)) {
  794. for ($i = 0; isset($lightTrace[$i]); ++$i) {
  795. unset($lightTrace[$i]['args'], $lightTrace[$i]['object']);
  796. }
  797. }
  799. return $lightTrace;
  800. }
  802. /**
  803. * Parse the error message by removing the anonymous class notation
  804. * and using the parent class instead if possible.
  805. */
  806. private function parseAnonymousClass(string $message): string
  807. {
  808. return preg_replace_callback('/[a-zA-Z_\x7f-\xff][\\\\a-zA-Z0-9_\x7f-\xff]*+@anonymous\x00.*?\.php(?:0x?|:[0-9]++\$)?[0-9a-fA-F]++/', static function ($m) {
  809. return class_exists($m[0], false) ? (get_parent_class($m[0]) ?: key(class_implements($m[0])) ?: 'class').'@anonymous' : $m[0];
  810. }, $message);
  811. }
  812. }