src/EventSubscriber/UserSystem/LoginSuccessSubscriber.php line 69

Open in your IDE?
  1. <?php
  2. /**
  3.  * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
  4.  *
  5.  * Copyright (C) 2019 - 2020 Jan Böhmer (https://github.com/jbtronics)
  6.  *
  7.  * This program is free software: you can redistribute it and/or modify
  8.  * it under the terms of the GNU Affero General Public License as published
  9.  * by the Free Software Foundation, either version 3 of the License, or
  10.  * (at your option) any later version.
  11.  *
  12.  * This program is distributed in the hope that it will be useful,
  13.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15.  * GNU Affero General Public License for more details.
  16.  *
  17.  * You should have received a copy of the GNU Affero General Public License
  18.  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19.  */
  21. declare(strict_types=1);
  23. /**
  24.  * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
  25.  *
  26.  * Copyright (C) 2019 Jan Böhmer (https://github.com/jbtronics)
  27.  *
  28.  * This program is free software; you can redistribute it and/or
  29.  * modify it under the terms of the GNU General Public License
  30.  * as published by the Free Software Foundation; either version 2
  31.  * of the License, or (at your option) any later version.
  32.  *
  33.  * This program is distributed in the hope that it will be useful,
  34.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  35.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  36.  * GNU General Public License for more details.
  37.  *
  38.  * You should have received a copy of the GNU General Public License
  39.  * along with this program; if not, write to the Free Software
  40.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  41.  */
  43. namespace App\EventSubscriber\UserSystem;
  45. use App\Entity\LogSystem\UserLoginLogEntry;
  46. use App\Entity\UserSystem\User;
  47. use App\Services\LogSystem\EventLogger;
  48. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  49. use Symfony\Component\HttpFoundation\Session\Session;
  50. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  51. use Symfony\Component\Security\Http\Event\InteractiveLoginEvent;
  52. use Symfony\Component\Security\Http\SecurityEvents;
  53. use Symfony\Contracts\Translation\TranslatorInterface;
  55. /**
  56.  * This event listener shows an login successful flash to the user after login and write the login to event log.
  57.  */
  58. final class LoginSuccessSubscriber implements EventSubscriberInterface
  59. {
  60.     private $translator;
  61.     private $flashBag;
  62.     private $eventLogger;
  63.     private $gpdr_compliance;
  65.     public function __construct(TranslatorInterface $translator, SessionInterface $session, EventLogger $eventLogger, bool $gpdr_compliance)
  66.     {
  67.         /** @var Session $session */
  68.         $this->translator = $translator;
  69.         $this->flashBag = $session->getFlashBag();
  70.         $this->eventLogger = $eventLogger;
  71.         $this->gpdr_compliance = $gpdr_compliance;
  72.     }
  74.     public function onLogin(InteractiveLoginEvent $event): void
  75.     {
  76.         $ip = $event->getRequest()->getClientIp();
  77.         $log = new UserLoginLogEntry($ip, $this->gpdr_compliance);
  78.         $user = $event->getAuthenticationToken()->getUser();
  79.         if ($user instanceof User) {
  80.             $log->setTargetElement($user);
  81.         }
  82.         $this->eventLogger->logAndFlush($log);
  84.         $this->flashBag->add('notice', $this->translator->trans('flash.login_successful'));
  85.     }
  87.     /**
  88.      * Returns an array of event names this subscriber wants to listen to.
  89.      *
  90.      * The array keys are event names and the value can be:
  91.      *
  92.      *  * The method name to call (priority defaults to 0)
  93.      *  * An array composed of the method name to call and the priority
  94.      *  * An array of arrays composed of the method names to call and respective
  95.      *    priorities, or 0 if unset
  96.      *
  97.      * For instance:
  98.      *
  99.      *  * ['eventName' => 'methodName']
  100.      *  * ['eventName' => ['methodName', $priority]]
  101.      *  * ['eventName' => [['methodName1', $priority], ['methodName2']]]
  102.      *
  103.      * @return array The event names to listen to
  104.      */
  105.     public static function getSubscribedEvents(): array
  106.     {
  107.         return [SecurityEvents::INTERACTIVE_LOGIN => 'onLogin'];
  108.     }
  109. }