Merge pull request #163 from hackzilla/master

Update CaptchaType.php

Controller/CaptchaController.php

@@ -2,9 +2,9 @@
 
 namespace Gregwar\CaptchaBundle\Controller;
 
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
  * Generates a captcha via a URL
@@ -16,12 +16,13 @@ class CaptchaController extends Controller
     /**
      * Action that is used to generate the captcha, save its code, and stream the image
      *
-     * @param \Symfony\Component\HttpFoundation\Request $request
      * @param string $key
      *
-     * @return \Symfony\Component\HttpFoundation\Response
+     * @return Response
+     *
+     * @throws NotFoundHttpException
      */
-    public function generateCaptchaAction(Request $request, $key)
+    public function generateCaptchaAction($key)
     {
         $options = $this->container->getParameter('gregwar_captcha.config');
         $session = $this->get('session');
@@ -36,7 +37,7 @@ class CaptchaController extends Controller
         }
 
         if (!$isOk) {
-            throw $this->createNotFoundException('Unable to generate a captcha via an URL with this session key.');
+            return $this->error($options);
         }
 
         /* @var \Gregwar\CaptchaBundle\Generator\CaptchaGenerator $generator */
@@ -52,8 +53,31 @@ class CaptchaController extends Controller
 
         $response = new Response($generator->generate($options));
         $response->headers->set('Content-type', 'image/jpeg');
+        $response->headers->set('Pragma', 'no-cache');
+        $response->headers->set('Cache-Control', 'no-cache');
+
+        return $response;
+    }
+
+    /**
+     * Returns an empty image with status code 428 Precondition Required
+     *
+     * @param array $options
+     *
+     * @return Response
+     */
+    protected function error($options)
+    {
+        /* @var \Gregwar\CaptchaBundle\Generator\CaptchaGenerator $generator */
+        $generator = $this->container->get('gregwar_captcha.generator');
+        $generator->setPhrase('');
+
+        $response = new Response($generator->generate($options));
+        $response->setStatusCode(428);
+        $response->headers->set('Content-type', 'image/jpeg');
+        $response->headers->set('Pragma', 'no-cache');
+        $response->headers->set('Cache-Control', 'no-cache');
 
         return $response;
     }
 }
-

DependencyInjection/Configuration.php

@@ -44,10 +44,12 @@ class Configuration implements ConfigurationInterface
                 ->scalarNode('interpolation')->defaultValue(true)->end()
                 ->arrayNode('text_color')->prototype('scalar')->end()->end()
                 ->arrayNode('background_color')->prototype('scalar')->end()->end()
+                ->arrayNode('background_images')->prototype('scalar')->end()->end()
+                ->scalarNode('disabled')->defaultValue(false)->end()
+                ->scalarNode('ignore_all_effects')->defaultValue(false)->end()
             ->end()
         ;
 
         return $treeBuilder;
     }
 }
-

DependencyInjection/GregwarCaptchaExtension.php

@@ -16,7 +16,7 @@ class GregwarCaptchaExtension extends Extension
 {
     /**
      * @param array $configs
-     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
+     * @param ContainerBuilder $container
      */
     public function load(array $configs, ContainerBuilder $container)
     {

Generator/CaptchaGenerator.php

@@ -2,7 +2,8 @@
 
 namespace Gregwar\CaptchaBundle\Generator;
 
-use Symfony\Component\Finder\Finder;
+use Gregwar\Captcha\CaptchaBuilder;
+use Gregwar\Captcha\PhraseBuilder;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\Routing\RouterInterface;
 
@@ -18,7 +19,7 @@ use Gregwar\Captcha\PhraseBuilderInterface;
 class CaptchaGenerator
 {
     /**
-     * @var \Symfony\Component\Routing\RouterInterface
+     * @var RouterInterface
      */
     protected $router;
 
@@ -38,12 +39,17 @@ class CaptchaGenerator
     protected $imageFileHandler;
 
     /**
-     * @param \Symfony\Component\Routing\RouterInterface $router
+     * @param RouterInterface $router
      * @param CaptchaBuilderInterface $builder
-     * @param ImageFileHandlerInterface $imageFileHandler
+     * @param PhraseBuilderInterface $phraseBuilder
+     * @param ImageFileHandler $imageFileHandler
      */
-    public function __construct(RouterInterface $router, CaptchaBuilderInterface $builder, PhraseBuilderInterface $phraseBuilder, ImageFileHandler $imageFileHandler)
-    {
+    public function __construct(
+        RouterInterface $router,
+        CaptchaBuilderInterface $builder,
+        PhraseBuilderInterface $phraseBuilder,
+        ImageFileHandler $imageFileHandler
+    ) {
         $this->router           = $router;
         $this->builder          = $builder;
         $this->phraseBuilder    = $phraseBuilder;
@@ -53,7 +59,6 @@ class CaptchaGenerator
     /**
      * Get the captcha URL, stream, or filename that will go in the image's src attribute
      *
-     * @param $key
      * @param array $options
      *
      * @return array
@@ -71,7 +76,8 @@ class CaptchaGenerator
 
         // Returns the image generation URL
         if ($options['as_url']) {
-            return $this->router->generate('gregwar_captcha.generate_captcha', array('key' => $options['session_key']));
+            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));
@@ -86,7 +92,6 @@ class CaptchaGenerator
     }
 
     /**
-     * @param string $key
      * @param array $options
      *
      * @return string
@@ -120,6 +125,9 @@ class CaptchaGenerator
 
         $fingerprint = isset($options['fingerprint']) ? $options['fingerprint'] : null;
 
+        $this->builder->setBackgroundImages($options['background_images']);
+        $this->builder->setIgnoreAllEffects($options['ignore_all_effects']);
+
         $content = $this->builder->build(
             $options['width'],
             $options['height'],
@@ -142,7 +150,6 @@ class CaptchaGenerator
     }
 
     /**
-     * @param string $key
      * @param array $options
      *
      * @return string
@@ -160,4 +167,3 @@ class CaptchaGenerator
         return $phrase;
     }
 }
-

Generator/ImageFileHandler.php

@@ -103,4 +103,3 @@ class ImageFileHandler
         }
     }
 }
-

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) <2011-2013> Grégoire Passault
+Copyright (c) <2011-2015> Grégoire Passault
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,12 +1,15 @@
 Gregwar's CaptchaBundle
 =====================
 
-The `GregwarCaptchaBundle` adds support for a "captcha" form type for the
-Symfony2 form component.
+The `GregwarCaptchaBundle` adds support for a captcha form type for the
+Symfony form component.
 
-Important note: the master of this repository is containing current development
-in order to work with Symfony 2.1. If you are using Symfony 2.0 please checkout
-the 2.0 branch.
+Compatibility with Symfony
+==========================
+
+If you are using Symfony `< 2.8`, you should use version `1.*`
+
+If you are using SYmfony `>= 2.8`, you should use version `2.*`
 
 Installation
 ============
@@ -17,7 +20,15 @@ Ultimately, the GregwarCaptchaBundle files should be downloaded to the
 'vendor/bundles/Gregwar/CaptchaBundle' directory.
 
 You can accomplish this several ways, depending on your personal preference.
-The first method is the standard Symfony2 method.
+The first method is the standard Symfony method.
+
+***Using Composer***
+
+Use composer require to download and install the package.
+
+``` bash
+    composer require gregwar/captcha-bundle
+```
 
 ***Using the vendors script***
 
@@ -45,16 +56,6 @@ $ git submodule add git://github.com/Gregwar/CaptchaBundle.git vendor/bundles/Gr
 $ git submodule update --init
 ```
 
-***Using Composer***
-
-Add the following to the "require" section of your `composer.json` file:
-
-```
-    "gregwar/captcha-bundle": "dev-master"
-```
-
-And update your dependencies
-
 ### Step 2: Configure the Autoloader
 
 If you use composer, you can skip this step.
@@ -101,8 +102,11 @@ You can use the "captcha" type in your forms this way:
 
 ```php
 <?php
+    use Gregwar\CaptchaBundle\Type\CaptchaType;
     // ...
-    $builder->add('captcha', 'captcha'); // That's all !
+    $builder->add('captcha', CaptchaType::class); // That's all !
+    // If you're using php<5.5, you can use instead:
+    $builder->add('captcha', 'Gregwar\CaptchaBundle\Type\CaptchaType');
     // ...
 ```
 
@@ -123,8 +127,10 @@ You can define the following configuration options globally or on the CaptchaTyp
 
 * **width**: the width of the captcha image (default=120)
 * **height**: the height of the captcha image (default=40)
+* **disabled**: disable globally the CAPTCHAs (can be useful in dev environment), it will
+  still appear but won't be editable and won't be checked
 * **length**: the length of the captcha (number of chars, default 5)
-* **quality**: jpeg quality of captchas (default=15)
+* **quality**: jpeg quality of captchas (default=30)
 * **charset**: the charset used for code generation (default=abcdefhjkmnprstuvwxyz23456789)
 * **font**: the font to use (default is random among some pre-provided fonts), this should be an absolute path
 * **keep_value**: the value will be the same until the form is posted, even if the page is refreshed (default=true)
@@ -139,14 +145,17 @@ You can define the following configuration options globally or on the CaptchaTyp
 * **max_front_lines**, **max_behind_lines**: the maximum number of lines to draw on top/behind the image. `0` will draw no lines; `null` will use the default algorithm (the
 number of lines depends on the size of the image). (default=null)
 * **background_color**: sets the background color, if you want to force it, this should be an array of r,g &b, for instance [255, 255, 255] will force the background to be white
+* **background_images**: Sets custom user defined images as the captcha background (1 image is selected randomly). It is recommended to turn off all the effects on the image (ignore_all_effects). The full paths to the images must be passed.
 * **interpolation**: enable or disable the interpolation on the captcha
+* **ignore_all_effects**: Recommended to use when setting background images, will disable all image effects.
 
 Example :
 
 ```php
 <?php
+    use Gregwar\CaptchaBundle\Type\CaptchaType;
     // ...
-    $builder->add('captcha', 'captcha', array(
+    $builder->add('captcha', CaptchaType::class, array(
         'width' => 200,
         'height' => 50,
         'length' => 6,

Resources/config/routing/routing.yml

@@ -1,3 +1,3 @@
 gregwar_captcha.generate_captcha:
-    pattern:        /generate-captcha/{key}
-    defaults:       { _controller: GregwarCaptchaBundle:Captcha:generateCaptcha }
+    path:           /generate-captcha/{key}
+    defaults:       { _controller: GregwarCaptchaBundle:Captcha:generateCaptcha }

Resources/config/services.yml

@@ -1,24 +1,31 @@
+parameters:
+    gregwar_captcha.captcha_type.class: Gregwar\CaptchaBundle\Type\CaptchaType
+    gregwar_captcha.captcha_generator.class: Gregwar\CaptchaBundle\Generator\CaptchaGenerator
+    gregwar_captcha.image_file_handler.class: Gregwar\CaptchaBundle\Generator\ImageFileHandler
+    gregwar_captcha.captcha_builder.class: Gregwar\Captcha\CaptchaBuilder
+    gregwar_captcha.phrase_builder.class: Gregwar\Captcha\PhraseBuilder
+    
 services:
     captcha.type:
-        class: Gregwar\CaptchaBundle\Type\CaptchaType
+        class: %gregwar_captcha.captcha_type.class%
         arguments:
-            - @session
-            - @gregwar_captcha.generator
-            - @translator
+            - '@session'
+            - '@gregwar_captcha.generator'
+            - '@translator'
             - %gregwar_captcha.config%
         tags:
             - { name: form.type, alias: captcha }
 
     gregwar_captcha.generator:
-        class: Gregwar\CaptchaBundle\Generator\CaptchaGenerator
+        class: %gregwar_captcha.captcha_generator.class%
         arguments:
-            - @router
-            - @gregwar_captcha.captcha_builder
-            - @gregwar_captcha.phrase_builder
-            - @gregwar_captcha.image_file_handler
+            - '@router'
+            - '@gregwar_captcha.captcha_builder'
+            - '@gregwar_captcha.phrase_builder'
+            - '@gregwar_captcha.image_file_handler'
 
     gregwar_captcha.image_file_handler:
-        class: Gregwar\CaptchaBundle\Generator\ImageFileHandler
+        class: %gregwar_captcha.image_file_handler.class%
         arguments:
             - %gregwar_captcha.config.image_folder%
             - %gregwar_captcha.config.web_path%
@@ -26,7 +33,7 @@ services:
             - %gregwar_captcha.config.expiration%
 
     gregwar_captcha.captcha_builder:
-        class: Gregwar\Captcha\CaptchaBuilder
+        class: %gregwar_captcha.captcha_builder.class%
 
     gregwar_captcha.phrase_builder:
-        class: Gregwar\Captcha\PhraseBuilder
+        class: %gregwar_captcha.phrase_builder.class%

Resources/translations/gregwar_captcha.ar.yml

@@ -0,0 +1 @@
+Renew: تجديد

Resources/translations/gregwar_captcha.bg.yml

@@ -0,0 +1 @@
+Renew: Обнови

Resources/translations/gregwar_captcha.cs.yml

@@ -0,0 +1 @@
+Renew: Obnovit

Resources/translations/gregwar_captcha.de.yml

@@ -0,0 +1 @@
+Renew: Erneuern

Resources/translations/gregwar_captcha.en.yml

@@ -0,0 +1 @@
+Renew: Renew

Resources/translations/gregwar_captcha.nl.yml

@@ -0,0 +1 @@
+Renew: Vernieuwen

Resources/translations/gregwar_captcha.pl.yml

@@ -0,0 +1 @@
+Renew: Przeładuj

Resources/translations/gregwar_captcha.pt_BR.yml

@@ -0,0 +1 @@
+Renew: Regerar

Resources/translations/gregwar_captcha.tr.yml

@@ -0,0 +1 @@
+Renew: Yenile

Resources/translations/gregwar_captcha.uk.yml

@@ -0,0 +1 @@
+Renew: Оновити

Resources/translations/validators.ar.yml

@@ -0,0 +1 @@
+Bad code value: الرمز غير متطابق

Resources/translations/validators.bg.yml

@@ -0,0 +1 @@
+Bad code value: Грешен код

Resources/translations/validators.cs.yml

@@ -0,0 +1 @@
+Bad code value: Špatný kontrolní kód

Resources/translations/validators.de.yml

@@ -0,0 +1 @@
+Bad code value: Code stimmt nicht überein

Resources/translations/validators.en.yml

@@ -0,0 +1 @@
+Bad code value: Code does not match

Resources/translations/validators.nl.yml

@@ -0,0 +1 @@
+Bad code value: Code komt niet overeen

Resources/translations/validators.pl.yml

@@ -0,0 +1 @@
+Bad code value: Kod jest niepoprawny

Resources/translations/validators.pt_BR.yml

@@ -0,0 +1 @@
+Bad code value: Código de verificação inválido

Resources/translations/validators.tr.yml

@@ -0,0 +1 @@
+Bad code value: Kod eşleşmiyor

Resources/translations/validators.uk.yml

@@ -0,0 +1 @@
+Bad code value: Невірний код

Resources/views/captcha.html.twig

@@ -17,4 +17,3 @@
 {% endspaceless %}
 {% endif %}
 {% endblock %}
-

Type/CaptchaType.php

@@ -7,6 +7,7 @@ use Symfony\Component\Form\FormView;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\OptionsResolver\OptionsResolverInterface;
 use Symfony\Component\Form\FormEvents;
 use Symfony\Component\Translation\TranslatorInterface;
@@ -22,18 +23,12 @@ use Gregwar\CaptchaBundle\Generator\CaptchaGenerator;
 class CaptchaType extends AbstractType
 {
     /**
-     * @var \Symfony\Component\HttpFoundation\Session\SessionInterface
+     * @var SessionInterface
      */
     protected $session;
 
     /**
-     * The session key
-     * @var string
-     */
-    protected $key = null;
-
-    /**
-     * @var \Gregwar\CaptchaBundle\Generator\CaptchaGenerator
+     * @var CaptchaGenerator
      */
     protected $generator;
 
@@ -49,9 +44,10 @@ class CaptchaType extends AbstractType
     private $options = array();
 
     /**
-     * @param \Symfony\Component\HttpFoundation\Session\SessionInterface $session
-     * @param \Gregwar\CaptchaBundle\Generator\CaptchaGenerator $generator
-     * @param array $options
+     * @param SessionInterface    $session
+     * @param CaptchaGenerator    $generator
+     * @param TranslatorInterface $translator
+     * @param array               $options
      */
     public function __construct(SessionInterface $session, CaptchaGenerator $generator, TranslatorInterface $translator, $options)
     {
@@ -62,53 +58,48 @@ class CaptchaType extends AbstractType
     }
 
     /**
-     * @param \Symfony\Component\Form\FormBuilderInterface $builder
-     * @param array $options
+     * {@inheritdoc}
      */
     public function buildForm(FormBuilderInterface $builder, array $options)
     {
-        $this->key = 'gcb_'.$builder->getForm()->getName();
-
         $validator = new CaptchaValidator(
             $this->translator,
             $this->session,
-            $this->key,
+            sprintf('gcb_%s', $builder->getForm()->getName()),
             $options['invalid_message'],
             $options['bypass_code'],
             $options['humanity']
         );
-
-        $builder->addEventListener(FormEvents::POST_BIND, array($validator, 'validate'));
+        $event = \Symfony\Component\HttpKernel\Kernel::VERSION >= 2.3 ? FormEvents::POST_SUBMIT : FormEvents::POST_BIND;
+        $builder->addEventListener($event, array($validator, 'validate'));
     }
 
     /**
-     * @param \Symfony\Component\Form\FormView $view
-     * @param \Symfony\Component\Form\FormInterface $form
-     * @param array $options
+     * {@inheritdoc}
      */
     public function buildView(FormView $view, FormInterface $form, array $options)
     {
-        $isHuman = false;
-
         if ($options['reload'] && !$options['as_url']) {
             throw new \InvalidArgumentException('GregwarCaptcha: The reload option cannot be set without as_url, see the README for more information');
         }
 
+        $sessionKey = sprintf('gcb_%s', $form->getName());
+        $isHuman    = false;
+
         if ($options['humanity'] > 0) {
-            $humanityKey = $this->key.'_humanity';
+            $humanityKey = sprintf('%s_humanity', $sessionKey);
             if ($this->session->get($humanityKey, 0) > 0) {
                 $isHuman = true;
             }
         }
 
         if ($options['as_url']) {
-            $key = $this->key;
             $keys = $this->session->get($options['whitelist_key'], array());
-            if (!in_array($key, $keys)) {
-                $keys[] = $key;
+            if (!in_array($sessionKey, $keys)) {
+                $keys[] = $sessionKey;
             }
             $this->session->set($options['whitelist_key'], $keys);
-            $options['session_key'] = $this->key;
+            $options['session_key'] = $sessionKey;
         }
 
         $view->vars = array_merge($view->vars, array(
@@ -122,34 +113,52 @@ class CaptchaType extends AbstractType
         ));
 
         $persistOptions = array();
-        foreach (array('phrase', 'width', 'height', 'distortion', 'length', 'quality') as $key) {
+        foreach (array('phrase', 'width', 'height', 'distortion', 'length', 'quality', 'background_color', 'text_color') as $key) {
             $persistOptions[$key] = $options[$key];
         }
 
-        $this->session->set($this->key, $persistOptions);
+        $this->session->set($sessionKey, $persistOptions);
     }
 
     /**
-     * @param \Symfony\Component\OptionsResolver\OptionsResolverInterface $resolver
+     * {@inheritdoc}
      */
-    public function setDefaultOptions(OptionsResolverInterface $resolver)
+    public function configureOptions(OptionsResolver $resolver)
     {
         $this->options['mapped'] = false;
         $resolver->setDefaults($this->options);
     }
 
+    /**
+     * {@inheritdoc}
+     * BC for SF < 2.7
+     */
+    public function setDefaultOptions(OptionsResolverInterface $resolver)
+    {
+        $this->configureOptions($resolver);
+    }
+
     /**
      * @return string
      */
     public function getParent()
     {
-        return 'text';
+        // Not using ::class to support Symfony 2.8 w/ php>=5.3.9
+        return 'Symfony\Component\Form\Extension\Core\Type\TextType';
     }
 
     /**
      * @return string
      */
     public function getName()
+    {
+        return $this->getBlockPrefix();
+    }
+
+    /**
+     * @return string
+     */
+    public function getBlockPrefix()
     {
         return 'captcha';
     }

Validator/CaptchaValidator.php

@@ -15,7 +15,7 @@ use Symfony\Component\Translation\TranslatorInterface;
 class CaptchaValidator
 {
     /**
-     * @var \Symfony\Component\HttpFoundation\Session\SessionInterface
+     * @var SessionInterface
      */
     private $session;
 
@@ -47,10 +47,12 @@ class CaptchaValidator
     private $translator;
 
     /**
-     * @param \Symfony\Component\HttpFoundation\Session\SessionInterface $session
-     * @param string $key
-     * @param string $invalidMessage
-     * @param string|null $bypassCode
+     * @param TranslatorInterface $translator
+     * @param SessionInterface    $session
+     * @param string              $key
+     * @param string              $invalidMessage
+     * @param string              $bypassCode
+     * @param int                 $humanity
      */
     public function __construct(TranslatorInterface $translator, SessionInterface $session, $key, $invalidMessage, $bypassCode, $humanity)
     {
@@ -58,7 +60,7 @@ class CaptchaValidator
         $this->session          = $session;
         $this->key              = $key;
         $this->invalidMessage   = $invalidMessage;
-        $this->bypassCode       = $bypassCode;
+        $this->bypassCode       = (string)$bypassCode;
         $this->humanity         = $humanity;
     }
 
@@ -67,7 +69,7 @@ class CaptchaValidator
      */
     public function validate(FormEvent $event)
     {
-        $form = $form = $event->getForm();
+        $form = $event->getForm();
 
         $code = $form->getData();
         $expectedCode = $this->getExpectedCode();
@@ -80,7 +82,7 @@ class CaptchaValidator
             }
         }
 
-        if (!($code && is_string($code) && ($this->compare($code, $expectedCode) || $this->compare($code, $this->bypassCode)))) {
+        if (!($code !== null && is_string($code) && ($this->compare($code, $expectedCode) || $this->compare($code, $this->bypassCode)))) {
             $form->addError(new FormError($this->translator->trans($this->invalidMessage, array(), 'validators')));
         } else {
             if ($this->humanity > 0) {
@@ -112,7 +114,7 @@ class CaptchaValidator
     }
 
     /**
-     * Retreive the humanity
+     * Retrieve the humanity
      *
      * @return mixed|null
      */
@@ -157,6 +159,6 @@ class CaptchaValidator
      */
     protected function compare($code, $expectedCode)
     {
-        return ($expectedCode && is_string($expectedCode) && $this->niceize($code) == $this->niceize($expectedCode));
+        return ($expectedCode !== null && is_string($expectedCode) && $this->niceize($code) == $this->niceize($expectedCode));
     }
 }

composer.json

@@ -17,13 +17,14 @@
         }
     ],
     "require": {
-        "php": ">=5.3.0",
-        "gregwar/captcha": "v1.0.8"
+        "php": ">=5.3.9",
+        "gregwar/captcha": "~1.1",
+        "symfony/framework-bundle": "~2.1|~3.0",
+        "symfony/form": "~2.1|~3.0"
     },
     "autoload": {
-        "psr-0": {
-            "Gregwar\\CaptchaBundle": ""
+        "psr-4": {
+            "Gregwar\\CaptchaBundle\\": "/"
         }
-    },
-    "target-dir": "Gregwar/CaptchaBundle"
+    }
 }