vendor/shopware/storefront/Framework/Captcha/CaptchaRouteListener.php line 59

Open in your IDE?
  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\Annotation\Captcha as CaptchaAnnotation;
  12. use Shopware\Storefront\Framework\Captcha\Exception\CaptchaInvalidException;
  13. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  14. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  15. use Symfony\Component\HttpKernel\KernelEvents;
  17. /**
  18.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  19.  */
  20. #[Package('storefront')]
  21. class CaptchaRouteListener implements EventSubscriberInterface
  22. {
  23.     /**
  24.      * @var iterable<AbstractCaptcha>
  25.      */
  26.     private iterable $captchas;
  28.     private ErrorController $errorController;
  30.     private SystemConfigService $systemConfigService;
  32.     /**
  33.      * @internal
  34.      *
  35.      * @param iterable<AbstractCaptcha> $captchas
  36.      */
  37.     public function __construct(
  38.         iterable $captchas,
  39.         ErrorController $errorController,
  40.         SystemConfigService $systemConfigService
  41.     ) {
  42.         $this->captchas = $captchas;
  43.         $this->errorController = $errorController;
  44.         $this->systemConfigService = $systemConfigService;
  45.     }
  47.     /**
  48.      * {@inheritdoc}
  49.      */
  50.     public static function getSubscribedEvents(): array
  51.     {
  52.         return [
  53.             KernelEvents::CONTROLLER => [
  54.                 ['validateCaptcha', KernelListenerPriorities::KERNEL_CONTROLLER_EVENT_SCOPE_VALIDATE],
  55.             ],
  56.         ];
  57.     }
  59.     public function validateCaptcha(ControllerEvent $event): void
  60.     {
  61.         /** @var CaptchaAnnotation|bool $captchaAnnotation */
  62.         $captchaAnnotation = $event->getRequest()->attributes->get(PlatformRequest::ATTRIBUTE_CAPTCHA, false);
  64.         if ($captchaAnnotation === false) {
  65.             return;
  66.         }
  68.         /** @var SalesChannelContext|null $context */
  69.         $context = $event->getRequest()->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  71.         $salesChannelId = $context ? $context->getSalesChannelId() : null;
  73.         $activeCaptchas = (array) ($this->systemConfigService->get('core.basicInformation.activeCaptchasV2', $salesChannelId) ?? []);
  75.         foreach ($this->captchas as $captcha) {
  76.             $captchaConfig = $activeCaptchas[$captcha->getName()] ?? [];
  77.             $request = $event->getRequest();
  78.             if (
  79.                 $captcha->supports($request, $captchaConfig) && !$captcha->isValid($request, $captchaConfig)
  80.             ) {
  81.                 if ($captcha->shouldBreak()) {
  82.                     throw new CaptchaInvalidException($captcha);
  83.                 }
  85.                 $violations = $captcha->getViolations();
  87.                 $event->setController(function () use (
  88.                     $violations,
  89.                     $request
  90.                 ) {
  91.                     return $this->errorController->onCaptchaFailure($violations, $request);
  92.                 });
  94.                 // Return on first invalid captcha
  95.                 return;
  96.             }
  97.         }
  98.     }
  99. }