src/Storefront/Framework/Captcha/CaptchaRouteListener.php line 43

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Framework\Captcha;
  5. use Shopware\Core\Framework\Log\Package;
  6. use Shopware\Core\Framework\Routing\KernelListenerPriorities;
  7. use Shopware\Core\PlatformRequest;
  8. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  9. use Shopware\Core\System\SystemConfig\SystemConfigService;
  10. use Shopware\Storefront\Controller\ErrorController;
  11. use Shopware\Storefront\Framework\Captcha\Exception\CaptchaInvalidException;
  12. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  13. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  14. use Symfony\Component\HttpKernel\KernelEvents;
  16. /**
  17.  * @internal
  18.  */
  19. #[Package('storefront')]
  20. class CaptchaRouteListener implements EventSubscriberInterface
  21. {
  22.     /**
  23.      * @internal
  24.      *
  25.      * @param iterable<AbstractCaptcha> $captchas
  26.      */
  27.     public function __construct(private readonly iterable $captchas, private readonly ErrorController $errorController, private readonly SystemConfigService $systemConfigService)
  28.     {
  29.     }
  31.     /**
  32.      * {@inheritdoc}
  33.      */
  34.     public static function getSubscribedEvents(): array
  35.     {
  36.         return [
  37.             KernelEvents::CONTROLLER => [
  38.                 ['validateCaptcha', KernelListenerPriorities::KERNEL_CONTROLLER_EVENT_SCOPE_VALIDATE],
  39.             ],
  40.         ];
  41.     }
  43.     public function validateCaptcha(ControllerEvent $event): void
  44.     {
  45.         /** @var bool $captchaAnnotation */
  46.         $captchaAnnotation = $event->getRequest()->attributes->get(PlatformRequest::ATTRIBUTE_CAPTCHA, false);
  48.         if ($captchaAnnotation === false) {
  49.             return;
  50.         }
  52.         /** @var SalesChannelContext|null $context */
  53.         $context = $event->getRequest()->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  55.         $salesChannelId = $context ? $context->getSalesChannelId() : null;
  57.         $activeCaptchas = (array) ($this->systemConfigService->get('core.basicInformation.activeCaptchasV2', $salesChannelId) ?? []);
  59.         foreach ($this->captchas as $captcha) {
  60.             $captchaConfig = $activeCaptchas[$captcha->getName()] ?? [];
  61.             $request = $event->getRequest();
  62.             if (
  63.                 $captcha->supports($request, $captchaConfig) && !$captcha->isValid($request, $captchaConfig)
  64.             ) {
  65.                 if ($captcha->shouldBreak()) {
  66.                     throw new CaptchaInvalidException($captcha);
  67.                 }
  69.                 $violations = $captcha->getViolations();
  71.                 $event->setController(fn () => $this->errorController->onCaptchaFailure($violations, $request));
  73.                 // Return on first invalid captcha
  74.                 return;
  75.             }
  76.         }
  77.     }
  78. }