vendor/symfony/twig-bundle/Controller/ExceptionController.php line 59

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\Bundle\TwigBundle\Controller;
  14. use Symfony\Component\Debug\Exception\FlattenException;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
  18. use Twig\Environment;
  19. use Twig\Error\LoaderError;
  20. use Twig\Loader\ExistsLoaderInterface;
  21. use Twig\Loader\SourceContextLoaderInterface;
  23. @trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "%s" instead.', ExceptionController::class, \Symfony\Component\HttpKernel\Controller\ErrorController::class), E_USER_DEPRECATED);
  25. /**
  26.  * ExceptionController renders error or exception pages for a given
  27.  * FlattenException.
  28.  *
  29.  * @author Fabien Potencier <fabien@symfony.com>
  30.  * @author Matthias Pigulla <mp@webfactory.de>
  31.  *
  32.  * @deprecated since Symfony 4.4, use Symfony\Component\HttpKernel\Controller\ErrorController instead.
  33.  */
  34. class ExceptionController
  35. {
  36.     protected $twig;
  37.     protected $debug;
  39.     /**
  40.      * @param bool $debug Show error (false) or exception (true) pages by default
  41.      */
  42.     public function __construct(Environment $twig, bool $debug)
  43.     {
  44.         $this->twig = $twig;
  45.         $this->debug = $debug;
  46.     }
  48.     /**
  49.      * Converts an Exception to a Response.
  50.      *
  51.      * A "showException" request parameter can be used to force display of an error page (when set to false) or
  52.      * the exception page (when true). If it is not present, the "debug" value passed into the constructor will
  53.      * be used.
  54.      *
  55.      * @return Response
  56.      *
  57.      * @throws \InvalidArgumentException When the exception template does not exist
  58.      */
  59.     public function showAction(Request $request, FlattenException $exception, DebugLoggerInterface $logger = null)
  60.     {
  61.         $currentContent = $this->getAndCleanOutputBuffering($request->headers->get('X-Php-Ob-Level', -1));
  62.         $showException = $request->attributes->get('showException', $this->debug); // As opposed to an additional parameter, this maintains BC
  64.         $code = $exception->getStatusCode();
  66.         return new Response($this->twig->render(
  67.             (string) $this->findTemplate($request, $request->getRequestFormat(), $code, $showException),
  68.             [
  69.                 'status_code' => $code,
  70.                 'status_text' => isset(Response::$statusTexts[$code]) ? Response::$statusTexts[$code] : '',
  71.                 'exception' => $exception,
  72.                 'logger' => $logger,
  73.                 'currentContent' => $currentContent,
  74.             ]
  75.         ), 200, ['Content-Type' => $request->getMimeType($request->getRequestFormat()) ?: 'text/html']);
  76.     }
  78.     /**
  79.      * @param int $startObLevel
  80.      *
  81.      * @return string
  82.      */
  83.     protected function getAndCleanOutputBuffering($startObLevel)
  84.     {
  85.         if (ob_get_level() <= $startObLevel) {
  86.             return '';
  87.         }
  89.         Response::closeOutputBuffers($startObLevel + 1, true);
  91.         return ob_get_clean();
  92.     }
  94.     /**
  95.      * @param string $format
  96.      * @param int    $code          An HTTP response status code
  97.      * @param bool   $showException
  98.      *
  99.      * @return string
  100.      */
  101.     protected function findTemplate(Request $request, $format, $code, $showException)
  102.     {
  103.         $name = $showException ? 'exception' : 'error';
  104.         if ($showException && 'html' == $format) {
  105.             $name = 'exception_full';
  106.         }
  108.         // For error pages, try to find a template for the specific HTTP status code and format
  109.         if (!$showException) {
  110.             $template = sprintf('@Twig/Exception/%s%s.%s.twig', $name, $code, $format);
  111.             if ($this->templateExists($template)) {
  112.                 return $template;
  113.             }
  114.         }
  116.         // try to find a template for the given format
  117.         $template = sprintf('@Twig/Exception/%s.%s.twig', $name, $format);
  118.         if ($this->templateExists($template)) {
  119.             return $template;
  120.         }
  122.         // default to a generic HTML exception
  123.         $request->setRequestFormat('html');
  125.         return sprintf('@Twig/Exception/%s.html.twig', $showException ? 'exception_full' : $name);
  126.     }
  128.     // to be removed when the minimum required version of Twig is >= 2.0
  129.     protected function templateExists($template)
  130.     {
  131.         $template = (string) $template;
  133.         $loader = $this->twig->getLoader();
  135.         if (1 === Environment::MAJOR_VERSION && !$loader instanceof ExistsLoaderInterface) {
  136.             try {
  137.                 if ($loader instanceof SourceContextLoaderInterface) {
  138.                     $loader->getSourceContext($template);
  139.                 } else {
  140.                     $loader->getSource($template);
  141.                 }
  143.                 return true;
  144.             } catch (LoaderError $e) {
  145.             }
  147.             return false;
  148.         }
  150.         return $loader->exists($template);
  151.     }
  152. }