Merge pull request #200 from adamwojs/fix_deprecated_tree_builder_root_call

Fixed deprecated TreeBuilder::root method call in SF 4

Controller/CaptchaController.php

@@ -2,8 +2,8 @@
 
 namespace Gregwar\CaptchaBundle\Controller;
 
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
@@ -11,7 +11,7 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  *
  * @author Jeremy Livingston <jeremy.j.livingston@gmail.com>
  */
-class CaptchaController extends Controller
+class CaptchaController extends AbstractController
 {
     /**
      * Action that is used to generate the captcha, save its code, and stream the image
@@ -37,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 */
@@ -54,7 +54,29 @@ 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');
+        $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

@@ -14,8 +14,14 @@ class Configuration implements ConfigurationInterface
      */
     public function getConfigTreeBuilder()
     {
-        $treeBuilder = new TreeBuilder();
+        $treeBuilder = new TreeBuilder('gregwar_captcha');
-        $rootNode = $treeBuilder->root('gregwar_captcha');
+
+        if (method_exists($treeBuilder, 'getRootNode')) {
+            $rootNode = $treeBuilder->getRootNode();
+        } else {
+            // BC for symfony/config <= 4.1
+            $rootNode = $treeBuilder->root('gregwar_captcha');
+        }
 
         $rootNode
             ->addDefaultsIfNotSet()
@@ -33,7 +39,7 @@ class Configuration implements ConfigurationInterface
                 ->scalarNode('web_path')->defaultValue('%kernel.root_dir%/../web')->end()
                 ->scalarNode('gc_freq')->defaultValue(100)->end()
                 ->scalarNode('expiration')->defaultValue(60)->end()
-                ->scalarNode('quality')->defaultValue(30)->end()
+                ->scalarNode('quality')->defaultValue(50)->end()
                 ->scalarNode('invalid_message')->defaultValue('Bad code value')->end()
                 ->scalarNode('bypass_code')->defaultValue(null)->end()
                 ->scalarNode('whitelist_key')->defaultValue('captcha_whitelist_key')->end()
@@ -44,7 +50,10 @@ 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()
+                ->scalarNode('session_key')->defaultValue('captcha')->end()
             ->end()
         ;
 

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)
     {
@@ -34,6 +34,6 @@ class GregwarCaptchaExtension extends Extension
         $container->setParameter('gregwar_captcha.config.whitelist_key', $config['whitelist_key']);
 
         $resources = $container->getParameter('twig.form.resources');
-        $container->setParameter('twig.form.resources', array_merge(array('GregwarCaptchaBundle::captcha.html.twig'), $resources));
+        $container->setParameter('twig.form.resources', array_merge(array('@GregwarCaptcha/captcha.html.twig'), $resources));
     }
 }

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

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,19 @@
 Gregwar's CaptchaBundle
 =====================
 
-The `GregwarCaptchaBundle` adds support for a "captcha" form type for the
+[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YUXRLWHQSWS6L)
-Symfony2 form component.
 
-Important note: the master of this repository is containing current development
+The `GregwarCaptchaBundle` adds support for a captcha form type for the
-in order to work with Symfony 2.1. If you are using Symfony 2.0 please checkout
+Symfony form component.
-the 2.0 branch.
+
+It uses [gregwar/captcha](https://github.com/Gregwar/Captcha) as captcha generator, which is a separate standalone library that can be used for none-symfony projects.
+
+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 +24,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 +60,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 +106,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');
     // ...
 ```
 
@@ -141,14 +149,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}
+    path:           /generate-captcha/{key}
-    defaults:       { _controller: GregwarCaptchaBundle:Captcha:generateCaptcha }
+    defaults:       { _controller: Gregwar\CaptchaBundle\Controller\CaptchaController::generateCaptchaAction }

Resources/config/services.yml

@@ -7,33 +7,38 @@ parameters:
     
 services:
     captcha.type:
-        class: %gregwar_captcha.captcha_type.class%
+        class: '%gregwar_captcha.captcha_type.class%'
+        public: true
         arguments:
-            - @session
+            - '@session'
-            - @gregwar_captcha.generator
+            - '@gregwar_captcha.generator'
-            - @translator
+            - '@translator'
-            - %gregwar_captcha.config%
+            - '%gregwar_captcha.config%'
         tags:
             - { name: form.type, alias: captcha }
 
     gregwar_captcha.generator:
-        class: %gregwar_captcha.captcha_generator.class%
+        class: '%gregwar_captcha.captcha_generator.class%'
+        public: true
         arguments:
-            - @router
+            - '@router'
-            - @gregwar_captcha.captcha_builder
+            - '@gregwar_captcha.captcha_builder'
-            - @gregwar_captcha.phrase_builder
+            - '@gregwar_captcha.phrase_builder'
-            - @gregwar_captcha.image_file_handler
+            - '@gregwar_captcha.image_file_handler'
 
     gregwar_captcha.image_file_handler:
-        class: %gregwar_captcha.image_file_handler.class%
+        class: '%gregwar_captcha.image_file_handler.class%'
+        public: true
         arguments:
-            - %gregwar_captcha.config.image_folder%
+            - '%gregwar_captcha.config.image_folder%'
-            - %gregwar_captcha.config.web_path%
+            - '%gregwar_captcha.config.web_path%'
-            - %gregwar_captcha.config.gc_freq%
+            - '%gregwar_captcha.config.gc_freq%'
-            - %gregwar_captcha.config.expiration%
+            - '%gregwar_captcha.config.expiration%'
 
     gregwar_captcha.captcha_builder:
-        class: %gregwar_captcha.captcha_builder.class%
+        class: '%gregwar_captcha.captcha_builder.class%'
+        public: true
 
     gregwar_captcha.phrase_builder:
-        class: %gregwar_captcha.phrase_builder.class%
+        class: '%gregwar_captcha.phrase_builder.class%'
+        public: true

Resources/translations/gregwar_captcha.ar.yml

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

Resources/translations/gregwar_captcha.tr.yml

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

Resources/translations/validators.ar.yml

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

Resources/translations/validators.tr.yml

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

Resources/views/captcha.html.twig

@@ -2,8 +2,8 @@
 {% if is_human %}
 -
 {% else %}
-{% spaceless %}
+{% apply spaceless %}
-    <img id="{{ image_id }}" src="{{ captcha_code }}" alt="" title="captcha" width="{{ captcha_width }}" height="{{ captcha_height }}" />
+    <img class="captcha_image" id="{{ image_id }}" src="{{ captcha_code }}" alt="" title="captcha" width="{{ captcha_width }}" height="{{ captcha_height }}" />
     {% if reload %}
     <script type="text/javascript">
         function reload_{{ image_id }}() {
@@ -14,7 +14,6 @@
     <a class="captcha_reload" href="javascript:reload_{{ image_id }}();">{{ 'Renew'|trans({}, 'gregwar_captcha') }}</a>
     {% endif %}
     {{ form_widget(form) }}
-{% endspaceless %}
+{% endapply %}
 {% 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;
@@ -21,6 +22,8 @@ use Gregwar\CaptchaBundle\Generator\CaptchaGenerator;
  */
 class CaptchaType extends AbstractType
 {
+    const SESSION_KEY_PREFIX = '_captcha_';
+
     /**
      * @var SessionInterface
      */
@@ -52,7 +55,7 @@ class CaptchaType extends AbstractType
     {
         $this->session      = $session;
         $this->generator    = $generator;
-        $this->translator = $translator;
+        $this->translator   = $translator;
         $this->options      = $options;
     }
 
@@ -64,13 +67,13 @@ class CaptchaType extends AbstractType
         $validator = new CaptchaValidator(
             $this->translator,
             $this->session,
-            sprintf('gcb_%s', $builder->getForm()->getName()),
+            sprintf('%s%s', self::SESSION_KEY_PREFIX, $options['session_key']),
             $options['invalid_message'],
             $options['bypass_code'],
             $options['humanity']
         );
-
+        $event = \Symfony\Component\HttpKernel\Kernel::VERSION >= 2.3 ? FormEvents::POST_SUBMIT : FormEvents::POST_BIND;
-        $builder->addEventListener(FormEvents::POST_BIND, array($validator, 'validate'));
+        $builder->addEventListener($event, array($validator, 'validate'));
     }
 
     /**
@@ -82,7 +85,7 @@ class CaptchaType extends AbstractType
             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());
+        $sessionKey = sprintf('%s%s', self::SESSION_KEY_PREFIX, $options['session_key']);
         $isHuman    = false;
 
         if ($options['humanity'] > 0) {
@@ -112,7 +115,8 @@ class CaptchaType extends AbstractType
         ));
 
         $persistOptions = array();
-        foreach (array('phrase', 'width', 'height', 'distortion', 'length', 'quality', 'background_color', 'text_color') as $key) {
+        foreach (array('phrase', 'width', 'height', 'distortion', 'length',
+        'quality', 'background_color', 'background_images', 'text_color') as $key) {
             $persistOptions[$key] = $options[$key];
         }
 
@@ -122,24 +126,42 @@ class CaptchaType extends AbstractType
     /**
      * {@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';
     }

composer.json

@@ -17,15 +17,15 @@
         }
     ],
     "require": {
-        "php": ">=5.3.0",
+        "php": ">=5.3.9",
-        "gregwar/captcha": "~1.0.12",
+        "gregwar/captcha": "~1.1",
-        "symfony/framework-bundle": "~2.1",
+        "symfony/framework-bundle": "~2.8|~3.0|~4.0",
-        "symfony/form": "~2.1"
+        "symfony/form": "~2.8|~3.0|~4.0",
+        "twig/twig": "^1.40|^2.9"
     },
     "autoload": {
-        "psr-0": {
+        "psr-4": {
-            "Gregwar\\CaptchaBundle": ""
+            "Gregwar\\CaptchaBundle\\": "/"
         }
-    },
+    }
-    "target-dir": "Gregwar/CaptchaBundle"
 }