vendor/gregwar/captcha-bundle/Generator/CaptchaGenerator.php line 86

  1. <?php
  3. declare(strict_types=1);
  5. namespace Gregwar\CaptchaBundle\Generator;
  7. use Gregwar\Captcha\CaptchaBuilder;
  8. use Gregwar\Captcha\PhraseBuilder;
  9. use Symfony\Component\Routing\RouterInterface;
  11. /**
  12.  * Uses configuration parameters to call the services that generate captcha images.
  13.  *
  14.  * @author Gregwar <g.passault@gmail.com>
  15.  * @author Jeremy Livingston <jeremy.j.livingston@gmail.com>
  16.  */
  17. class CaptchaGenerator
  18. {
  19.     /** @var RouterInterface */
  20.     protected $router;
  22.     /** @var CaptchaBuilder */
  23.     protected $builder;
  25.     /** @var PhraseBuilder */
  26.     protected $phraseBuilder;
  28.     /** @var ImageFileHandler */
  29.     protected $imageFileHandler;
  31.     /**
  32.      * @param RouterInterface         $router
  33.      * @param CaptchaBuilder          $builder
  34.      * @param PhraseBuilder           $phraseBuilder
  35.      * @param ImageFileHandler        $imageFileHandler
  36.      */
  37.     public function __construct(
  38.         RouterInterface $router,
  39.         CaptchaBuilder $builder,
  40.         PhraseBuilder $phraseBuilder,
  41.         ImageFileHandler $imageFileHandler
  42.     ) {
  43.         $this->router = $router;
  44.         $this->builder = $builder;
  45.         $this->phraseBuilder = $phraseBuilder;
  46.         $this->imageFileHandler = $imageFileHandler;
  47.     }
  49.     /**
  50.      * @param array<mixed> $options
  51.      *
  52.      * @return string
  53.      */
  54.     public function getCaptchaCode(array &$options): string
  55.     {
  56.         $this->builder->setPhrase($this->getPhrase($options));
  58.         // Randomly execute garbage collection and returns the image filename
  59.         if ($options['as_file']) {
  60.             $this->imageFileHandler->collectGarbage();
  62.             return $this->generate($options);
  63.         }
  65.         // Returns the image generation URL
  66.         if ($options['as_url']) {
  67.             return $this->router->generate(
  68.                 'gregwar_captcha.generate_captcha',
  69.                 array('key' => $options['session_key'], 'n' => md5(microtime(true).mt_rand()))
  70.             );
  71.         }
  73.         return 'data:image/jpeg;base64,'.base64_encode($this->generate($options));
  74.     }
  76.     public function setPhrase(string $phrase): void
  77.     {
  78.         $this->builder->setPhrase($phrase);
  79.     }
  81.     /**
  82.      * @param array<mixed> $options
  83.      *
  84.      * @return string
  85.      */
  86.     public function generate(array &$options): string
  87.     {
  88.         $this->builder->setDistortion($options['distortion']);
  90.         $this->builder->setMaxFrontLines($options['max_front_lines']);
  91.         $this->builder->setMaxBehindLines($options['max_behind_lines']);
  93.         if (isset($options['text_color']) && $options['text_color']) {
  94.             if (3 !== count($options['text_color'])) {
  95.                 throw new \RuntimeException('text_color should be an array of r, g and b');
  96.             }
  98.             $color = $options['text_color'];
  99.             $this->builder->setTextColor($color[0], $color[1], $color[2]);
  100.         }
  102.         if (isset($options['background_color']) && $options['background_color']) {
  103.             if (3 !== count($options['background_color'])) {
  104.                 throw new \RuntimeException('background_color should be an array of r, g and b');
  105.             }
  107.             $color = $options['background_color'];
  108.             $this->builder->setBackgroundColor($color[0], $color[1], $color[2]);
  109.         }
  111.         $this->builder->setInterpolation($options['interpolation']);
  113.         $fingerprint = isset($options['fingerprint']) ? $options['fingerprint'] : null;
  115.         $this->builder->setBackgroundImages($options['background_images']);
  116.         $this->builder->setIgnoreAllEffects($options['ignore_all_effects']);
  118.         $content = $this->builder->build(
  119.             $options['width'],
  120.             $options['height'],
  121.             $options['font'],
  122.             $fingerprint
  123.         )->getGd();
  125.         if ($options['keep_value']) {
  126.             $options['fingerprint'] = $this->builder->getFingerprint();
  127.         }
  129.         if (!$options['as_file']) {
  130.             ob_start();
  131.             imagejpeg($content, null, $options['quality']);
  133.             $bufferContents = ob_get_clean();
  135.             return false === $bufferContents ? '' : $bufferContents;
  136.         }
  138.         return $this->imageFileHandler->saveAsFile($content);
  139.     }
  141.     /**
  142.      * @param array<mixed> $options
  143.      *
  144.      * @return string
  145.      */
  146.     public function getPhrase(array &$options): string
  147.     {
  148.         // Get the phrase that we'll use for this image
  149.         if ($options['keep_value'] && isset($options['phrase'])) {
  150.             $phrase = $options['phrase'];
  151.         } else {
  152.             $phrase = $this->phraseBuilder->build($options['length'], $options['charset']);
  153.             $options['phrase'] = $phrase;
  154.         }
  156.         return $phrase;
  157.     }
  158. }