src/Security/Api/Authorization/Voter/ActiveModuleVoter.php line 21

Open in your IDE?
  1. <?php
  3. namespace App\Security\Api\Authorization\Voter;
  5. use App\Entity\Api\CoreModule\User;
  6. use App\Helper\Api\Constants\Entity\Properties\Entity as PropertyNamesEntity;
  7. use App\Helper\Api\Entity\RequestDataContainer;
  8. use App\Security\Api\Authorization\VoterAttribute\AbstractVoterAttribute;
  9. use App\Validator\Api\Data\CoreModule\ModuleDataValidator;
  10. use LogicException;
  11. use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
  12. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  13. use Symfony\Component\Validator\Exception\ValidationFailedException;
  15. /**
  16.  * API active module voter.
  17.  *
  18.  * @package API
  19.  * @internal
  20.  */
  21. class ActiveModuleVoter extends AbstractApiBaseVoter
  22. {
  24.     /**
  25.      * Validator interface.
  26.      *
  27.      * @var ModuleDataValidator
  28.      */
  29.     protected ModuleDataValidator $validator;
  31.     /**
  32.      * Constructor.
  33.      *
  34.      * @param ModuleDataValidator $validator
  35.      */
  36.     public function __construct(ModuleDataValidator $validator)
  37.     {
  38.         $this->validator = $validator;
  39.     }
  41.     /**
  42.      * Determines if the attribute and subject are supported by this voter.
  43.      *
  44.      * @param string $attribute An attribute.
  45.      * @param mixed $subject The subject to secure, e.g. an object the user wants to access or any other PHP type.
  46.      *
  47.      * @return bool
  48.      */
  49.     protected function supports(string $attribute, $subject): bool
  50.     {
  51.         // requires data container
  52.         if (!$subject instanceof RequestDataContainer) {
  53.             return false;
  54.         }
  56.         // votes then on every API call when attribute format is valid
  57.         return AbstractVoterAttribute::isValidAttribute($attribute);
  58.     }
  60.     /**
  61.      * Perform a single access check operation on a given attribute, subject and token.
  62.      * It is safe to assume that $attribute and $subject already passed the "supports()" method check.
  63.      *
  64.      * @param string $attribute An attribute.
  65.      * @param mixed $subject The subject to secure, e.g. an object the user wants to access or any other PHP type.
  66.      * @param TokenInterface $token The token interface.
  67.      * @return bool
  68.      */
  69.     protected function voteOnAttribute(string $attribute, mixed $subject, TokenInterface $token): bool
  70.     {
  71.         $user = $token->getUser();
  72.         if (!$user instanceof User) {
  73.             // the user must be logged in, otherwise deny access
  74.             return false;
  75.         }
  76.         if (!$this->supports($attribute, $subject)) {
  77.             throw new LogicException('This code should not be reached!');
  78.         }
  79.         if (!$subject instanceof RequestDataContainer) {
  80.             throw new LogicException('This voter requires a RequestDataContainer object passed as subject!');
  81.         }
  82.         try {
  83.             $this->validator->validateIsModuleActive([
  84.                 PropertyNamesEntity::ID => AbstractVoterAttribute::getModuleIdFromAttribute($attribute),
  85.             ]);
  86.         } catch (ValidationFailedException $exception) {
  87.             // get message of first violation and issue an access violation when module is inactive
  88.             $violations = $exception->getViolations();
  89.             $subject->setException(new AccessDeniedHttpException($violations->get(0)->getMessage(), $exception));
  91.             return false;
  92.         }
  94.         return true;
  95.     }
  97. }