CaptchaGenerator.php

<?php

declare(strict_types=1);

namespace Gregwar\CaptchaBundle\Generator;

use GdImage;
use Gregwar\Captcha\CaptchaBuilder;
use Gregwar\Captcha\PhraseBuilder;
use Symfony\Component\Routing\RouterInterface;

/**
 * Uses configuration parameters to call the services that generate captcha images.
 *
 * @author Gregwar <g.passault@gmail.com>
 * @author Jeremy Livingston <jeremy.j.livingston@gmail.com>
 */
class CaptchaGenerator
{
    protected RouterInterface $router;

    protected CaptchaBuilder $builder;

    protected PhraseBuilder $phraseBuilder;

    protected ImageFileHandler $imageFileHandler;

    /**
     * @param RouterInterface         $router
     * @param CaptchaBuilder          $builder
     * @param PhraseBuilder           $phraseBuilder
     * @param ImageFileHandler        $imageFileHandler
     */
    public function __construct(
        RouterInterface $router,
        CaptchaBuilder $builder,
        PhraseBuilder $phraseBuilder,
        ImageFileHandler $imageFileHandler
    ) {
        $this->router = $router;
        $this->builder = $builder;
        $this->phraseBuilder = $phraseBuilder;
        $this->imageFileHandler = $imageFileHandler;
    }

    /**
     * @param array<mixed> $options
     */
    public function getCaptchaCode(array &$options): string
    {
        $this->builder->setPhrase($this->getPhrase($options));

        // Randomly execute garbage collection and returns the image filename
        if ($options['as_file']) {
            $this->imageFileHandler->collectGarbage();

            return $this->generate($options);
        }

        // Returns the image generation URL
        if ($options['as_url']) {
            return $this->router->generate(
                'gregwar_captcha.generate_captcha',
                array('key' => $options['session_key'], 'n' => md5(microtime(true).mt_rand()))
            );
        }

        return 'data:image/jpeg;base64,'.base64_encode($this->generate($options));
    }

    public function setPhrase(string $phrase): void
    {
        $this->builder->setPhrase($phrase);
    }

    /**
     * @param array<mixed> $options
     */
    public function generate(array &$options): string
    {
        $this->builder->setDistortion($options['distortion']);

        $this->builder->setMaxFrontLines($options['max_front_lines']);
        $this->builder->setMaxBehindLines($options['max_behind_lines']);

        if (isset($options['text_color']) && $options['text_color']) {
            if (3 !== count($options['text_color'])) {
                throw new \RuntimeException('text_color should be an array of r, g and b');
            }

            $color = $options['text_color'];
            $this->builder->setTextColor($color[0], $color[1], $color[2]);
        }

        if (isset($options['background_color']) && $options['background_color']) {
            if (3 !== count($options['background_color'])) {
                throw new \RuntimeException('background_color should be an array of r, g and b');
            }

            $color = $options['background_color'];
            $this->builder->setBackgroundColor($color[0], $color[1], $color[2]);
        }

        $this->builder->setInterpolation($options['interpolation']);

        $fingerprint = $options['fingerprint'] ?? null;

        $this->builder->setBackgroundImages($options['background_images']);
        $this->builder->setIgnoreAllEffects($options['ignore_all_effects']);

        /** @var GdImage $content */
        $content = $this->builder->build(
            $options['width'],
            $options['height'],
            $options['font'],
            $fingerprint
        )->getGd();

        if ($options['keep_value']) {
            $options['fingerprint'] = $this->builder->getFingerprint();
        }

        if (!$options['as_file']) {
            ob_start();
            imagejpeg($content, null, $options['quality']);

            $bufferContents = ob_get_clean();

            return false === $bufferContents ? '' : $bufferContents;
        }

        return $this->imageFileHandler->saveAsFile($content);
    }

    /**
     * @param array<mixed> $options
     */
    public function getPhrase(array &$options): string
    {
        // Get the phrase that we'll use for this image
        if ($options['keep_value'] && isset($options['phrase'])) {
            $phrase = $options['phrase'];
        } else {
            $phrase = $this->phraseBuilder->build($options['length'], $options['charset']);
            $options['phrase'] = $phrase;
        }

        return $phrase;
    }
}