vendor/contao/core-bundle/src/Resources/contao/pages/PageError404.php line 80

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Contao.
  5.  *
  6.  * (c) Leo Feyer
  7.  *
  8.  * @license LGPL-3.0-or-later
  9.  */
  11. namespace Contao;
  13. use Contao\CoreBundle\Exception\ForwardPageNotFoundException;
  14. use Contao\CoreBundle\Exception\PageNotFoundException;
  15. use Contao\CoreBundle\Util\LocaleUtil;
  16. use Symfony\Component\HttpFoundation\Response;
  18. /**
  19.  * Provide methods to handle an error 404 page.
  20.  */
  21. class PageError404 extends Frontend
  22. {
  23.     /**
  24.      * Generate an error 404 page
  25.      *
  26.      * @param PageModel|null $page
  27.      *
  28.      * @deprecated Deprecated since Contao 4.9, to be removed in Contao 5; use
  29.      *             the PageError404::getResponse() method instead
  30.      */
  31.     public function generate($page=null)
  32.     {
  33.         trigger_deprecation('contao/core-bundle', '4.9', 'Using PageError404::generate() has been deprecated in Contao 4.9 and will be removed in Contao 5.0. Use the PageError404::getResponse() method instead.');
  35.         /** @var PageModel $objPage */
  36.         global $objPage;
  38.         $obj404 = $this->prepare($page);
  39.         $objPage = $obj404->loadDetails();
  41.         // Reset inherited cache timeouts (see #231)
  42.         if (!$objPage->includeCache)
  43.         {
  44.             $objPage->cache = 0;
  45.             $objPage->clientCache = 0;
  46.         }
  48.         /** @var PageRegular $objHandler */
  49.         $objHandler = new $GLOBALS['TL_PTY']['regular']();
  51.         header('HTTP/1.1 404 Not Found');
  52.         $objHandler->generate($objPage);
  53.     }
  55.     /**
  56.      * Return a response object
  57.      *
  58.      * @param PageModel|null $page
  59.      *
  60.      * @return Response
  61.      */
  62.     public function getResponse($page=null)
  63.     {
  64.         /** @var PageModel $objPage */
  65.         global $objPage;
  67.         $obj404 = $this->prepare($page);
  68.         $objPage = $obj404->loadDetails();
  70.         // Reset inherited cache timeouts (see #231)
  71.         if (!$objPage->includeCache)
  72.         {
  73.             $objPage->cache = 0;
  74.             $objPage->clientCache = 0;
  75.         }
  77.         /** @var PageRegular $objHandler */
  78.         $objHandler = new $GLOBALS['TL_PTY']['regular']();
  80.         return $objHandler->getResponse($objPage)->setStatusCode(404);
  81.     }
  83.     /**
  84.      * Prepare the output
  85.      *
  86.      * @param PageModel|null $page
  87.      *
  88.      * @return PageModel
  89.      *
  90.      * @internal Do not call this method in your code. It will be made private in Contao 5.0.
  91.      */
  92.     protected function prepare($page=null)
  93.     {
  94.         $obj404 = null;
  96.         if ($page instanceof PageModel && $page->type === 'error_404')
  97.         {
  98.             // We don't actually need a root page, we just need the inherited properties to redirect a 404
  99.             $obj404 = $objRootPage = $page->loadDetails();
  100.         }
  101.         else
  102.         {
  103.             $objRootPage = $this->getRootPageFromUrl();
  104.         }
  106.         // Forward if the language should be but is not set (see #4028)
  107.         if ($objRootPage->urlPrefix && System::getContainer()->getParameter('contao.legacy_routing'))
  108.         {
  109.             // Get the request string without the script name
  110.             $strRequest = Environment::get('relativeRequest');
  112.             // Only redirect if there is no language fragment (see #4669)
  113.             if ($strRequest && !preg_match('@^[a-z]{2}(-[A-Z]{2})?/@', $strRequest))
  114.             {
  115.                 // Handle language fragments without trailing slash (see #7666)
  116.                 if (preg_match('@^[a-z]{2}(-[A-Z]{2})?$@', $strRequest))
  117.                 {
  118.                     $this->redirect(Environment::get('request') . '/', 301);
  119.                 }
  120.                 else
  121.                 {
  122.                     if ($strRequest == Environment::get('request'))
  123.                     {
  124.                         $strRequest = LocaleUtil::formatAsLanguageTag($objRootPage->language) . '/' . $strRequest;
  125.                     }
  126.                     else
  127.                     {
  128.                         $strRequest = Environment::get('script') . '/' . LocaleUtil::formatAsLanguageTag($objRootPage->language) . '/' . $strRequest;
  129.                     }
  131.                     $this->redirect($strRequest);
  132.                 }
  133.             }
  134.         }
  136.         // Look for a 404 page
  137.         if (null === $obj404)
  138.         {
  139.             $obj404 = PageModel::find404ByPid($objRootPage->id);
  140.         }
  142.         // Die if there is no page at all
  143.         if (null === $obj404)
  144.         {
  145.             throw new PageNotFoundException('Page not found: ' . Environment::get('uri'));
  146.         }
  148.         // Forward to another page
  149.         if ($obj404->autoforward && $obj404->jumpTo)
  150.         {
  151.             $objNextPage = PageModel::findPublishedById($obj404->jumpTo);
  153.             if (null === $objNextPage)
  154.             {
  155.                 System::getContainer()->get('monolog.logger.contao.error')->error('Forward page ID "' . $obj404->jumpTo . '" does not exist');
  157.                 throw new ForwardPageNotFoundException('Forward page not found');
  158.             }
  160.             $this->redirect($objNextPage->getFrontendUrl());
  161.         }
  163.         return $obj404;
  164.     }
  165. }
  167. class_alias(PageError404::class, 'PageError404');