vendor/gregwar/captcha-bundle/Validator/CaptchaValidator.php line 97

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Gregwar\CaptchaBundle\Validator;
  7. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  8. use Symfony\Component\Form\FormError;
  9. use Symfony\Component\Form\FormEvent;
  10. use Symfony\Contracts\Translation\TranslatorInterface;
  12. /**
  13.  * Captcha validator.
  14.  *
  15.  * @author Gregwar <g.passault@gmail.com>
  16.  */
  17. class CaptchaValidator
  18. {
  19.     /** @var SessionInterface */
  20.     private $session;
  22.     /**
  23.      * Session key to store the code.
  24.      *
  25.      * @var string
  26.      */
  27.     private $key;
  29.     /**
  30.      * Error message text for non-matching submissions.
  31.      *
  32.      * @var string
  33.      */
  34.     private $invalidMessage;
  36.     /**
  37.      * Configuration parameter used to bypass a required code match.
  38.      *
  39.      * @var string|null
  40.      */
  41.     private $bypassCode;
  43.     /**
  44.      * Number of form that the user can submit without captcha.
  45.      *
  46.      * @var int
  47.      */
  48.     private $humanity;
  50.     /**
  51.      * Translator.
  52.      *
  53.      * @var TranslatorInterface
  54.      */
  55.     private $translator;
  57.     public function __construct(
  58.         TranslatorInterface $translator,
  59.         SessionInterface $session,
  60.         string $key,
  61.         string $invalidMessage,
  62.         ?string $bypassCode,
  63.         int $humanity
  64.     ) {
  65.         $this->translator = $translator;
  66.         $this->session = $session;
  67.         $this->key = $key;
  68.         $this->invalidMessage = $invalidMessage;
  69.         $this->bypassCode = $bypassCode;
  70.         $this->humanity = $humanity;
  71.     }
  73.     public function validate(FormEvent $event): void
  74.     {
  75.         $form = $event->getForm();
  77.         $code = $form->getData();
  78.         $expectedCode = $this->getExpectedCode();
  80.         if ($this->humanity > 0) {
  81.             $humanity = $this->getHumanity();
  82.             if ($humanity > 0) {
  83.                 $this->updateHumanity($humanity - 1);
  85.                 return;
  86.             }
  87.         }
  89.         if (!(null !== $code && is_string($code) && ($this->compare($code, $expectedCode) || $this->compare($code, $this->bypassCode)))) {
  90.             $form->addError(new FormError($this->translator->trans($this->invalidMessage, array(), 'validators')));
  91.         } else {
  92.             if ($this->humanity > 0) {
  93.                 $this->updateHumanity($this->humanity);
  94.             }
  95.         }
  97.         $this->session->remove($this->key);
  99.         if ($this->session->has($this->key.'_fingerprint')) {
  100.             $this->session->remove($this->key.'_fingerprint');
  101.         }
  102.     }
  104.     /**
  105.      * Retrieve the expected CAPTCHA code.
  106.      *
  107.      * @return mixed|null
  108.      */
  109.     protected function getExpectedCode()
  110.     {
  111.         $options = $this->session->get($this->key, array());
  113.         if (is_array($options) && isset($options['phrase'])) {
  114.             return $options['phrase'];
  115.         }
  117.         return null;
  118.     }
  120.     /**
  121.      * Retrieve the humanity.
  122.      *
  123.      * @return mixed|null
  124.      */
  125.     protected function getHumanity()
  126.     {
  127.         return $this->session->get($this->key.'_humanity', 0);
  128.     }
  130.     protected function updateHumanity(int $newValue): void
  131.     {
  132.         if ($newValue > 0) {
  133.             $this->session->set($this->key.'_humanity', $newValue);
  134.         } else {
  135.             $this->session->remove($this->key.'_humanity');
  136.         }
  137.     }
  139.     protected function niceize(string $code): string
  140.     {
  141.         return strtr(strtolower($code), 'oil', '01l');
  142.     }
  144.     /**
  145.      * Run a match comparison on the provided code and the expected code.
  146.      *
  147.      * @param string      $code
  148.      * @param string|null $expectedCode
  149.      *
  150.      * @return bool
  151.      */
  152.     protected function compare(string $code, ?string $expectedCode): bool
  153.     {
  154.         return null !== $expectedCode && is_string($expectedCode) && $this->niceize($code) == $this->niceize($expectedCode);
  155.     }
  156. }