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

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Framework\Captcha;
  5. use Shopware\Core\Framework\Routing\KernelListenerPriorities;
  6. use Shopware\Core\PlatformRequest;
  7. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  8. use Shopware\Core\System\SystemConfig\SystemConfigService;
  9. use Shopware\Storefront\Controller\ErrorController;
  10. use Shopware\Storefront\Framework\Captcha\Annotation\Captcha as CaptchaAnnotation;
  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.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  18.  */
  19. class CaptchaRouteListener implements EventSubscriberInterface
  20. {
  21.     /**
  22.      * @var iterable<AbstractCaptcha>
  23.      */
  24.     private iterable $captchas;
  26.     private ErrorController $errorController;
  28.     private SystemConfigService $systemConfigService;
  30.     /**
  31.      * @internal
  32.      *
  33.      * @param iterable<AbstractCaptcha> $captchas
  34.      */
  35.     public function __construct(
  36.         iterable $captchas,
  37.         ErrorController $errorController,
  38.         SystemConfigService $systemConfigService
  39.     ) {
  40.         $this->captchas = $captchas;
  41.         $this->errorController = $errorController;
  42.         $this->systemConfigService = $systemConfigService;
  43.     }
  45.     /**
  46.      * {@inheritdoc}
  47.      */
  48.     public static function getSubscribedEvents(): array
  49.     {
  50.         return [
  51.             KernelEvents::CONTROLLER => [
  52.                 ['validateCaptcha', KernelListenerPriorities::KERNEL_CONTROLLER_EVENT_SCOPE_VALIDATE],
  53.             ],
  54.         ];
  55.     }
  57.     public function validateCaptcha(ControllerEvent $event): void
  58.     {
  59.         /** @var CaptchaAnnotation|bool $captchaAnnotation */
  60.         $captchaAnnotation = $event->getRequest()->attributes->get(PlatformRequest::ATTRIBUTE_CAPTCHA, false);
  62.         if ($captchaAnnotation === false) {
  63.             return;
  64.         }
  66.         /** @var SalesChannelContext|null $context */
  67.         $context = $event->getRequest()->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT);
  69.         $salesChannelId = $context ? $context->getSalesChannelId() : null;
  71.         $activeCaptchas = (array) ($this->systemConfigService->get('core.basicInformation.activeCaptchasV2', $salesChannelId) ?? []);
  73.         foreach ($this->captchas as $captcha) {
  74.             $captchaConfig = $activeCaptchas[$captcha->getName()] ?? [];
  75.             $request = $event->getRequest();
  76.             if (
  77.                 $captcha->supports($request, $captchaConfig) && !$captcha->isValid($request, $captchaConfig)
  78.             ) {
  79.                 if ($captcha->shouldBreak()) {
  80.                     throw new CaptchaInvalidException($captcha);
  81.                 }
  83.                 $violations = $captcha->getViolations();
  85.                 $event->setController(function () use (
  86.                     $violations,
  87.                     $request
  88.                 ) {
  89.                     return $this->errorController->onCaptchaFailure($violations, $request);
  90.                 });
  92.                 // Return on first invalid captcha
  93.                 return;
  94.             }
  95.         }
  96.     }
  97. }