vendor/contao/core-bundle/src/Controller/FaviconController.php line 30

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\CoreBundle\Controller;
  15. use Contao\CoreBundle\Framework\ContaoFramework;
  16. use Contao\FilesModel;
  17. use Contao\PageModel;
  18. use FOS\HttpCache\ResponseTagger;
  19. use Symfony\Component\HttpFoundation\BinaryFileResponse;
  20. use Symfony\Component\HttpFoundation\Request;
  21. use Symfony\Component\HttpFoundation\Response;
  22. use Symfony\Component\Routing\Annotation\Route;
  23. use Webmozart\PathUtil\Path;
  25. /**
  26.  * @Route(defaults={"_scope" = "frontend"})
  27.  *
  28.  * @internal
  29.  */
  30. class FaviconController
  31. {
  32.     /**
  33.      * @var ContaoFramework
  34.      */
  35.     private $contaoFramework;
  37.     /**
  38.      * @var string
  39.      */
  40.     private $projectDir;
  42.     /**
  43.      * @var ResponseTagger|null
  44.      */
  45.     private $responseTagger;
  47.     public function __construct(ContaoFramework $contaoFramework, string $projectDir, ResponseTagger $responseTagger = null)
  48.     {
  49.         $this->contaoFramework = $contaoFramework;
  50.         $this->projectDir = $projectDir;
  51.         $this->responseTagger = $responseTagger;
  52.     }
  54.     /**
  55.      * @Route("/favicon.ico")
  56.      */
  57.     public function __invoke(Request $request): Response
  58.     {
  59.         $this->contaoFramework->initialize();
  61.         /** @var PageModel $pageModel */
  62.         $pageModel = $this->contaoFramework->getAdapter(PageModel::class);
  64.         /** @var PageModel|null $rootPage */
  65.         $rootPage = $pageModel->findPublishedFallbackByHostname(
  66.             $request->server->get('HTTP_HOST'),
  67.             ['fallbackToEmpty' => true]
  68.         );
  70.         if (null === $rootPage || null === ($favicon = $rootPage->favicon)) {
  71.             return new Response('', Response::HTTP_NOT_FOUND);
  72.         }
  74.         /** @var FilesModel $filesModel */
  75.         $filesModel = $this->contaoFramework->getAdapter(FilesModel::class);
  76.         $faviconModel = $filesModel->findByUuid($favicon);
  78.         if (null === $faviconModel) {
  79.             return new Response('', Response::HTTP_NOT_FOUND);
  80.         }
  82.         // Cache the response for 1 year and tag it, so it is invalidated when the settings are edited
  83.         $response = new BinaryFileResponse(Path::join($this->projectDir, $faviconModel->path));
  84.         $response->setSharedMaxAge(31556952);
  86.         switch ($faviconModel->extension) {
  87.             case 'svg':
  88.                 $response->headers->set('Content-Type', 'image/svg+xml');
  89.                 break;
  91.             case 'ico':
  92.                 $response->headers->set('Content-Type', 'image/x-icon');
  93.                 break;
  94.         }
  96.         if (null !== $this->responseTagger) {
  97.             $this->responseTagger->addTags(['contao.db.tl_page.'.$rootPage->id]);
  98.         }
  100.         return $response;
  101.     }
  102. }