vendor/contao/core-bundle/src/Controller/FrontendController.php line 90

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\Cron\Cron;
  16. use Contao\CoreBundle\Csrf\ContaoCsrfTokenManager;
  17. use Contao\FrontendIndex;
  18. use Contao\FrontendShare;
  19. use Symfony\Component\HttpFoundation\RedirectResponse;
  20. use Symfony\Component\HttpFoundation\Request;
  21. use Symfony\Component\HttpFoundation\Response;
  22. use Symfony\Component\Routing\Annotation\Route;
  23. use Symfony\Component\Security\Core\Exception\LogoutException;
  25. /**
  26.  * @Route(defaults={"_scope" = "frontend", "_token_check" = true})
  27.  *
  28.  * @internal
  29.  */
  30. class FrontendController extends AbstractController
  31. {
  32.     public function indexAction(): Response
  33.     {
  34.         $this->initializeContaoFramework();
  36.         trigger_deprecation('contao/core-bundle', '4.10', 'Using "Contao\FrontendController::indexAction()" has been deprecated and will no longer work in Contao 5.0. Use the Symfony routing instead.');
  38.         $controller = new FrontendIndex();
  40.         return $controller->run();
  41.     }
  43.     /**
  44.      * @Route("/_contao/cron", name="contao_frontend_cron")
  45.      */
  46.     public function cronAction(Request $request, Cron $cron): Response
  47.     {
  48.         if ($request->isMethod(Request::METHOD_GET)) {
  49.             $cron->run(Cron::SCOPE_WEB);
  50.         }
  52.         return new Response('', Response::HTTP_NO_CONTENT);
  53.     }
  55.     /**
  56.      * @Route("/_contao/share", name="contao_frontend_share")
  57.      */
  58.     public function shareAction(): RedirectResponse
  59.     {
  60.         $this->initializeContaoFramework();
  62.         $controller = new FrontendShare();
  64.         return $controller->run();
  65.     }
  67.     /**
  68.      * Symfony will un-authenticate the user automatically by calling this route.
  69.      *
  70.      * @throws LogoutException
  71.      *
  72.      * @Route("/_contao/logout", name="contao_frontend_logout")
  73.      */
  74.     public function logoutAction(): void
  75.     {
  76.         throw new LogoutException('The user was not logged out correctly.');
  77.     }
  79.     /**
  80.      * Generates a 1px transparent PNG image uncacheable response.
  81.      *
  82.      * This route can be used to include e.g. a hidden <img> tag to force
  83.      * a request to the application. That way, cookies can be set even if
  84.      * the output is cached (used in the core if the "alwaysLoadFromCache"
  85.      * option is enabled to evaluate the RememberMe cookie and then set
  86.      * the session cookie).
  87.      *
  88.      * @Route("/_contao/check_cookies", name="contao_frontend_check_cookies")
  89.      */
  90.     public function checkCookiesAction(): Response
  91.     {
  92.         static $image = 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=';
  94.         $response = new Response(base64_decode($image, true));
  95.         $response->setPrivate();
  96.         $response->headers->set('Content-Type', 'image/png');
  97.         $response->headers->addCacheControlDirective('no-store');
  98.         $response->headers->addCacheControlDirective('must-revalidate');
  100.         return $response;
  101.     }
  103.     /**
  104.      * Returns a script that makes sure a valid request token is filled into
  105.      * all forms if the "alwaysLoadFromCache" option is enabled.
  106.      *
  107.      * @Route("/_contao/request_token_script", name="contao_frontend_request_token_script")
  108.      */
  109.     public function requestTokenScriptAction(): Response
  110.     {
  111.         $token = $this
  112.             ->get(ContaoCsrfTokenManager::class)
  113.             ->getToken($this->getParameter('contao.csrf_token_name'))
  114.             ->getValue()
  115.         ;
  117.         $token = json_encode($token);
  119.         $response = new Response();
  120.         $response->setContent('document.querySelectorAll(\'input[name=REQUEST_TOKEN],input[name$="[REQUEST_TOKEN]"]\').forEach(function(i){i.value='.$token.'})');
  121.         $response->headers->set('Content-Type', 'application/javascript; charset=UTF-8');
  122.         $response->headers->addCacheControlDirective('no-store');
  123.         $response->headers->addCacheControlDirective('must-revalidate');
  125.         return $response;
  126.     }
  128.     public static function getSubscribedServices(): array
  129.     {
  130.         $services = parent::getSubscribedServices();
  132.         $services[] = ContaoCsrfTokenManager::class;
  134.         return $services;
  135.     }
  136. }