vendor/contao/core-bundle/src/Security/Logout/LogoutHandler.php line 27

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\Security\Logout;
  15. use Contao\CoreBundle\Framework\ContaoFramework;
  16. use Contao\CoreBundle\Monolog\ContaoContext;
  17. use Contao\System;
  18. use Contao\User;
  19. use Psr\Log\LoggerInterface;
  20. use Scheb\TwoFactorBundle\Security\Authentication\Token\TwoFactorTokenInterface;
  21. use Symfony\Component\HttpFoundation\Request;
  22. use Symfony\Component\HttpFoundation\Response;
  23. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  24. use Symfony\Component\Security\Http\Logout\LogoutHandlerInterface;
  25. use Symfony\Component\Security\Http\Util\TargetPathTrait;
  27. class LogoutHandler implements LogoutHandlerInterface
  28. {
  29.     use TargetPathTrait;
  31.     /**
  32.      * @var ContaoFramework
  33.      */
  34.     private $framework;
  36.     /**
  37.      * @var LoggerInterface|null
  38.      */
  39.     private $logger;
  41.     /**
  42.      * @internal Do not inherit from this class; decorate the "contao.security.logout_handler" service instead
  43.      */
  44.     public function __construct(ContaoFramework $framework, LoggerInterface $logger = null)
  45.     {
  46.         $this->framework = $framework;
  47.         $this->logger = $logger;
  48.     }
  50.     public function logout(Request $request, Response $response, TokenInterface $token): void
  51.     {
  52.         if ($request->hasSession() && method_exists($token, 'getProviderKey')) {
  53.             $this->removeTargetPath($request->getSession(), $token->getProviderKey());
  54.         }
  56.         $user = $token->getUser();
  58.         if (!$user instanceof User || $token instanceof TwoFactorTokenInterface) {
  59.             return;
  60.         }
  62.         if (null !== $this->logger) {
  63.             $this->logger->info(
  64.                 sprintf('User "%s" has logged out', $user->username),
  65.                 ['contao' => new ContaoContext(__METHOD__, ContaoContext::ACCESS, $user->username)]
  66.             );
  67.         }
  69.         $this->triggerPostLogoutHook($user);
  70.     }
  72.     private function triggerPostLogoutHook(User $user): void
  73.     {
  74.         $this->framework->initialize();
  76.         if (empty($GLOBALS['TL_HOOKS']['postLogout']) || !\is_array($GLOBALS['TL_HOOKS']['postLogout'])) {
  77.             return;
  78.         }
  80.         @trigger_error('Using the "postLogout" hook has been deprecated and will no longer work in Contao 5.0.', E_USER_DEPRECATED);
  82.         /** @var System $system */
  83.         $system = $this->framework->getAdapter(System::class);
  85.         $GLOBALS['TL_USERNAME'] = $user->getUsername();
  87.         foreach ($GLOBALS['TL_HOOKS']['postLogout'] as $callback) {
  88.             $system->importStatic($callback[0])->{$callback[1]}($user);
  89.         }
  90.     }
  91. }