src/EventSubscriber/Api/ChangedPasswordSubscriber.php line 86

Open in your IDE?
  1. <?php
  3. namespace App\EventSubscriber\Api;
  5. use App\Controller\Api\AbstractApiController;
  6. use App\Controller\Api\CoreModule\AuthenticationController;
  7. use App\Controller\Api\CoreModule\SessionController;
  8. use App\Entity\Api\CoreModule\User;
  9. use App\Helper\Api\JsonFormatter\Throwable\Formatter;
  10. use App\Helper\Api\Translator\ApiTranslator;
  11. use App\Validator\Constraints\Api\CoreModule\User\Attributes\NewPasswordNeededCompound;
  12. use Symfony\Component\HttpFoundation\Response;
  13. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  14. use Symfony\Component\HttpKernel\Exception\HttpException;
  15. use Symfony\Component\HttpKernel\KernelEvents;
  16. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  18. /**
  19.  * Subscriber for kernel controller event to force the user to change his temporary password.
  20.  *
  21.  * @package API
  22.  * @internal
  23.  */
  24. class ChangedPasswordSubscriber extends AbstractSubscriber
  25. {
  27.     /**
  28.      * Token storage to retrieve user.
  29.      *
  30.      * @var TokenStorageInterface
  31.      */
  32.     protected TokenStorageInterface $tokenStorage;
  34.     /**
  35.      * Returns an array of event names this subscriber wants to listen to.
  36.      *
  37.      * The array keys are event names and the value can be:
  38.      *
  39.      *  * The method name to call (priority defaults to 0)
  40.      *  * An array composed of the method name to call and the priority
  41.      *  * An array of arrays composed of the method names to call and respective
  42.      *    priorities, or 0 if unset
  43.      *
  44.      * For instance:
  45.      *
  46.      *  * ['eventName' => 'methodName']
  47.      *  * ['eventName' => ['methodName', $priority]]
  48.      *  * ['eventName' => [['methodName1', $priority], ['methodName2']]]
  49.      *
  50.      * The code must not depend on runtime state as it will only be called at compile time.
  51.      * All logic depending on runtime state must be put into the individual methods handling the events.
  52.      *
  53.      * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
  54.      * @noinspection PhpArrayShapeAttributeCanBeAddedInspection
  55.      * @noinspection PhpUnused
  56.      */
  57.     public static function getSubscribedEvents(): array
  58.     {
  59.         return [
  60.             KernelEvents::CONTROLLER => [
  61.                 ['ensureCustomPassword', 16]
  62.             ]
  63.         ];
  64.     }
  66.     /**
  67.      * Constructor.
  68.      *
  69.      * @param Formatter $formatter
  70.      * @param ApiTranslator $translator
  71.      * @param TokenStorageInterface $tokenStorage
  72.      */
  73.     public function __construct(Formatter $formatter, ApiTranslator $translator, TokenStorageInterface $tokenStorage)
  74.     {
  75.         parent::__construct($formatter, $translator);
  76.         $this->tokenStorage = $tokenStorage;
  77.     }
  79.     /**
  80.      * Force users to change their temporary password.
  81.      *
  82.      * @param ControllerEvent $event The controller event.
  83.      * @return void
  84.      * @noinspection PhpUnused
  85.      */
  86.     public function ensureCustomPassword(ControllerEvent $event): void
  87.     {
  88.         $method = null;
  89.         $controller = $event->getController();
  90.         // when a controller class defines multiple action methods, the controller
  91.         // is returned as [$controllerInstance, 'methodName']
  92.         if (is_array($controller)) {
  93.             $method = $controller[1];
  94.             $controller = $controller[0];
  95.         }
  96.         // limit to API controllers
  97.         if ($controller instanceof AbstractApiController) {
  98.             // ignore for authentication controller to allow login, logout, ping and password reset
  99.             if ($controller instanceof AuthenticationController) {
  100.                 return;
  101.             }
  102.             // ignore for session controller and certain methods to allow password and language change
  103.             if ($controller instanceof SessionController &&
  104.                 ($method === 'userPasswordUpdate' || $method === 'userLanguageUpdate')) {
  105.                 return;
  106.             }
  107.             $currentUser = $this->tokenStorage->getToken()->getUser();
  108.             /* @var User $currentUser */
  109.             /* @noinspection PhpClassConstantAccessedViaChildClassInspection */
  110.             if ($currentUser->getNewPasswordNeeded() === NewPasswordNeededCompound::YES) {
  111.                 throw new HttpException(
  112.                     Response::HTTP_FORBIDDEN,
  113.                     'User needs to change his temporary password first.'
  114.                 );
  115.             }
  116.         }
  117.     }
  119. }